@grapecity/gcpdfviewer
Version:
GcDocs PDF Viewer
4,446 lines • 856 kB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DsPdfViewer | Document Solutions PDF Viewer - v7.2.3</title><meta name="description" content="Documentation for Document Solutions PDF Viewer - v7.2.3"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Document Solutions PDF Viewer - v7.2.3</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
<li><a href="../index.html">Document Solutions PDF Viewer - v7.2.3</a></li>
<li><a href="DsPdfViewer.html">DsPdfViewer</a></li></ul>
<h1>Class DsPdfViewer</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>Document Solutions PDF Viewer (DsPdfViewer) is a fast JavaScript based client-side PDF Viewer that runs in all major browsers.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span>
</code></pre>
</div></section>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><a href="GcPdfViewer.html" class="tsd-signature-type" data-tsd-kind="Class">GcPdfViewer</a>
<ul class="tsd-hierarchy">
<li><span class="target">DsPdfViewer</span></li></ul></li></ul></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="DsPdfViewer.html#findControl" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>find<wbr/>Control</span></a>
<a href="DsPdfViewer.html#addAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#addAnnotationEditorPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Annotation<wbr/>Editor<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addArticlesPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Articles<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addAttachmentsPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Attachments<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addDefaultPanels" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Default<wbr/>Panels</span></a>
<a href="DsPdfViewer.html#addDocumentListPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Document<wbr/>List<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addFormEditorPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Form<wbr/>Editor<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addLayersPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Layers<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addOutlinePanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Outline<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addReplyTool" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Reply<wbr/>Tool</span></a>
<a href="DsPdfViewer.html#addSearchPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Search<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addSharedDocumentsPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Shared<wbr/>Documents<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addStamp" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Stamp</span></a>
<a href="DsPdfViewer.html#addStickyNote" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Sticky<wbr/>Note</span></a>
<a href="DsPdfViewer.html#addThumbnailsPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Thumbnails<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#addViewAreaStyle" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>View<wbr/>Area<wbr/>Style</span></a>
<a href="DsPdfViewer.html#applyOptions" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>apply<wbr/>Options</span></a>
<a href="DsPdfViewer.html#applyToolbarLayout" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>apply<wbr/>Toolbar<wbr/>Layout</span></a>
<a href="DsPdfViewer.html#applyViewPortScale" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>apply<wbr/>View<wbr/>Port<wbr/>Scale</span></a>
<a href="DsPdfViewer.html#bringPanelToFront" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>bring<wbr/>Panel<wbr/>To<wbr/>Front</span></a>
<a href="DsPdfViewer.html#changeBoundsOrigin" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>change<wbr/>Bounds<wbr/>Origin</span></a>
<a href="DsPdfViewer.html#changeOrigin" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>change<wbr/>Origin</span></a>
<a href="DsPdfViewer.html#changeOriginToBottom" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>change<wbr/>Origin<wbr/>To<wbr/>Bottom</span></a>
<a href="DsPdfViewer.html#changeOriginToTop" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>change<wbr/>Origin<wbr/>To<wbr/>Top</span></a>
<a href="DsPdfViewer.html#clearHighlightedSegments" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Highlighted<wbr/>Segments</span></a>
<a href="DsPdfViewer.html#cloneAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clone<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#close" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>close</span></a>
<a href="DsPdfViewer.html#closePanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>close<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#collectQuadPoints" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>collect<wbr/>Quad<wbr/>Points</span></a>
<a href="DsPdfViewer.html#confirm" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>confirm</span></a>
<a href="DsPdfViewer.html#convertPdfRectToWindowCoordinates" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>convert<wbr/>Pdf<wbr/>Rect<wbr/>To<wbr/>Window<wbr/>Coordinates</span></a>
<a href="DsPdfViewer.html#deletePage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Page</span></a>
<a href="DsPdfViewer.html#dispose" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>dispose</span></a>
<a href="DsPdfViewer.html#download" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>download</span></a>
<a href="DsPdfViewer.html#execCopyAction" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>exec<wbr/>Copy<wbr/>Action</span></a>
<a href="DsPdfViewer.html#execCutAction" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>exec<wbr/>Cut<wbr/>Action</span></a>
<a href="DsPdfViewer.html#execDeleteAction" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>exec<wbr/>Delete<wbr/>Action</span></a>
<a href="DsPdfViewer.html#execPasteAction" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>exec<wbr/>Paste<wbr/>Action</span></a>
<a href="DsPdfViewer.html#executeTask" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>execute<wbr/>Task</span></a>
<a href="DsPdfViewer.html#findAnnotations" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find<wbr/>Annotations</span></a>
<a href="DsPdfViewer.html#getDocumentInformation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Document<wbr/>Information</span></a>
<a href="DsPdfViewer.html#getDocumentSecurity" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Document<wbr/>Security</span></a>
<a href="DsPdfViewer.html#getEvent" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Event</span></a>
<a href="DsPdfViewer.html#getPageLocation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Page<wbr/>Location</span></a>
<a href="DsPdfViewer.html#getPageRotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Page<wbr/>Rotation</span></a>
<a href="DsPdfViewer.html#getPageSize" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Page<wbr/>Size</span></a>
<a href="DsPdfViewer.html#getPageTabs" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Page<wbr/>Tabs</span></a>
<a href="DsPdfViewer.html#getPanelState" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Panel<wbr/>State</span></a>
<a href="DsPdfViewer.html#getSelectedText" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Selected<wbr/>Text</span></a>
<a href="DsPdfViewer.html#getSharedDocuments" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Shared<wbr/>Documents</span></a>
<a href="DsPdfViewer.html#getSignatureInfo" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Signature<wbr/>Info</span></a>
<a href="DsPdfViewer.html#getViewPort" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>View<wbr/>Port</span></a>
<a href="DsPdfViewer.html#goBack" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>Back</span></a>
<a href="DsPdfViewer.html#goForward" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>Forward</span></a>
<a href="DsPdfViewer.html#goToFirstPage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>To<wbr/>First<wbr/>Page</span></a>
<a href="DsPdfViewer.html#goToLastPage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>To<wbr/>Last<wbr/>Page</span></a>
<a href="DsPdfViewer.html#goToNextPage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>To<wbr/>Next<wbr/>Page</span></a>
<a href="DsPdfViewer.html#goToPage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>To<wbr/>Page</span></a>
<a href="DsPdfViewer.html#goToPageNumber" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>To<wbr/>Page<wbr/>Number</span></a>
<a href="DsPdfViewer.html#goToPrevPage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>go<wbr/>To<wbr/>Prev<wbr/>Page</span></a>
<a href="DsPdfViewer.html#hideSecondToolbar" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>hide<wbr/>Second<wbr/>Toolbar</span></a>
<a href="DsPdfViewer.html#highlight" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>highlight</span></a>
<a href="DsPdfViewer.html#highlightTextSegment" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>highlight<wbr/>Text<wbr/>Segment</span></a>
<a href="DsPdfViewer.html#invalidate" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>invalidate</span></a>
<a href="DsPdfViewer.html#isFontUrlRegistered" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Font<wbr/>Url<wbr/>Registered</span></a>
<a href="DsPdfViewer.html#layoutPanels" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>layout<wbr/>Panels</span></a>
<a href="DsPdfViewer.html#load" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>load</span></a>
<a href="DsPdfViewer.html#loadAndScrollPageIntoView" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>load<wbr/>And<wbr/>Scroll<wbr/>Page<wbr/>Into<wbr/>View</span></a>
<a href="DsPdfViewer.html#loadDocumentList" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>load<wbr/>Document<wbr/>List</span></a>
<a href="DsPdfViewer.html#loadSharedDocuments" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>load<wbr/>Shared<wbr/>Documents</span></a>
<a href="DsPdfViewer.html#lockAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>lock<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#markAnnotationLayerDirty" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>mark<wbr/>Annotation<wbr/>Layer<wbr/>Dirty</span></a>
<a href="DsPdfViewer.html#newDocument" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>new<wbr/>Document</span></a>
<a href="DsPdfViewer.html#newPage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>new<wbr/>Page</span></a>
<a href="DsPdfViewer.html#open" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>open</span></a>
<a href="DsPdfViewer.html#openLocalFile" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>open<wbr/>Local<wbr/>File</span></a>
<a href="DsPdfViewer.html#openPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>open<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#openSharedDocument" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>open<wbr/>Shared<wbr/>Document</span></a>
<a href="DsPdfViewer.html#openSharedDocumentByIndex" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Index</span></a>
<a href="DsPdfViewer.html#openSharedDocumentByName" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Name</span></a>
<a href="DsPdfViewer.html#pdfStringToDate" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>pdf<wbr/>String<wbr/>To<wbr/>Date</span></a>
<a href="DsPdfViewer.html#print" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>print</span></a>
<a href="DsPdfViewer.html#redoChanges" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>redo<wbr/>Changes</span></a>
<a href="DsPdfViewer.html#registerFallbackFont" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>register<wbr/>Fallback<wbr/>Font</span></a>
<a href="DsPdfViewer.html#registerFont" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>register<wbr/>Font</span></a>
<a href="DsPdfViewer.html#removeAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#removeViewAreaStyle" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>View<wbr/>Area<wbr/>Style</span></a>
<a href="DsPdfViewer.html#repaint" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>repaint</span></a>
<a href="DsPdfViewer.html#repaintTextLayer" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>repaint<wbr/>Text<wbr/>Layer</span></a>
<a href="DsPdfViewer.html#resetDocument" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reset<wbr/>Document</span></a>
<a href="DsPdfViewer.html#resetForm" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reset<wbr/>Form</span></a>
<a href="DsPdfViewer.html#resolvePageIndex" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>resolve<wbr/>Page<wbr/>Index</span></a>
<a href="DsPdfViewer.html#resolveRegisteredFonts" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>resolve<wbr/>Registered<wbr/>Fonts</span></a>
<a href="DsPdfViewer.html#save" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>save</span></a>
<a href="DsPdfViewer.html#saveAsImages" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>save<wbr/>As<wbr/>Images</span></a>
<a href="DsPdfViewer.html#saveChanges" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>save<wbr/>Changes</span></a>
<a href="DsPdfViewer.html#scrollAnnotationIntoView" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>scroll<wbr/>Annotation<wbr/>Into<wbr/>View</span></a>
<a href="DsPdfViewer.html#scrollPageIntoView" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>scroll<wbr/>Page<wbr/>Into<wbr/>View</span></a>
<a href="DsPdfViewer.html#search" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>search</span></a>
<a href="DsPdfViewer.html#selectAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>select<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#setActiveBottomPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Active<wbr/>Bottom<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#setActiveTopPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Active<wbr/>Top<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#setAnnotationBounds" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Annotation<wbr/>Bounds</span></a>
<a href="DsPdfViewer.html#setPageRotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Page<wbr/>Rotation</span></a>
<a href="DsPdfViewer.html#setPageSize" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Page<wbr/>Size</span></a>
<a href="DsPdfViewer.html#setPageTabs" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Page<wbr/>Tabs</span></a>
<a href="DsPdfViewer.html#setTheme" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Theme</span></a>
<a href="DsPdfViewer.html#showAnnotationFocusOutline" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Annotation<wbr/>Focus<wbr/>Outline</span></a>
<a href="DsPdfViewer.html#showFormFiller" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Form<wbr/>Filler</span></a>
<a href="DsPdfViewer.html#showMessage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Message</span></a>
<a href="DsPdfViewer.html#showPanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#showPdfOrganizer" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Pdf<wbr/>Organizer</span></a>
<a href="DsPdfViewer.html#showReplaceText" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Replace<wbr/>Text</span></a>
<a href="DsPdfViewer.html#showSecondToolbar" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Second<wbr/>Toolbar</span></a>
<a href="DsPdfViewer.html#showSignTool" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>show<wbr/>Sign<wbr/>Tool</span></a>
<a href="DsPdfViewer.html#submitForm" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>submit<wbr/>Form</span></a>
<a href="DsPdfViewer.html#triggerEvent" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>trigger<wbr/>Event</span></a>
<a href="DsPdfViewer.html#undoChanges" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>undo<wbr/>Changes</span></a>
<a href="DsPdfViewer.html#unlockAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unlock<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#unselectAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unselect<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#updateAnnotation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#updateAnnotations" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>Annotations</span></a>
<a href="DsPdfViewer.html#updateGroupFieldValue" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>Group<wbr/>Field<wbr/>Value</span></a>
<a href="DsPdfViewer.html#updatePanel" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>Panel</span></a>
<a href="DsPdfViewer.html#validateForm" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate<wbr/>Form</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Accessors</h3>
<div class="tsd-index-list"><a href="DsPdfViewer.html#i18n" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>i18n</span></a>
<a href="DsPdfViewer.html#activatedEditorMode" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>activated<wbr/>Editor<wbr/>Mode</span></a>
<a href="DsPdfViewer.html#annotations" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>annotations</span></a>
<a href="DsPdfViewer.html#backgroundColor" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>background<wbr/>Color</span></a>
<a href="DsPdfViewer.html#beforeUnloadConfirmation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>before<wbr/>Unload<wbr/>Confirmation</span></a>
<a href="DsPdfViewer.html#canEditDocument" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>can<wbr/>Edit<wbr/>Document</span></a>
<a href="DsPdfViewer.html#currentUserName" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>current<wbr/>User<wbr/>Name</span></a>
<a href="DsPdfViewer.html#dataLoader" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>data<wbr/>Loader</span></a>
<a href="DsPdfViewer.html#document" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>document</span></a>
<a href="DsPdfViewer.html#editMode" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>edit<wbr/>Mode</span></a>
<a href="DsPdfViewer.html#errorHandler" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>error<wbr/>Handler</span></a>
<a href="DsPdfViewer.html#eventBus" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>event<wbr/>Bus</span></a>
<a href="DsPdfViewer.html#fileData" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>file<wbr/>Data</span></a>
<a href="DsPdfViewer.html#fileName" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>file<wbr/>Name</span></a>
<a href="DsPdfViewer.html#fileSize" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>file<wbr/>Size</span></a>
<a href="DsPdfViewer.html#fileUrl" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>file<wbr/>Url</span></a>
<a href="DsPdfViewer.html#fingerprint" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>fingerprint</span></a>
<a href="DsPdfViewer.html#gcPdfVersion" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>gc<wbr/>Pdf<wbr/>Version</span></a>
<a href="DsPdfViewer.html#hasChanges" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Changes</span></a>
<a href="DsPdfViewer.html#hasCopyData" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Copy<wbr/>Data</span></a>
<a href="DsPdfViewer.html#hasDocument" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Document</span></a>
<a href="DsPdfViewer.html#hasForm" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Form</span></a>
<a href="DsPdfViewer.html#hasPersistentConnection" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Persistent<wbr/>Connection</span></a>
<a href="DsPdfViewer.html#hasRedoChanges" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Redo<wbr/>Changes</span></a>
<a href="DsPdfViewer.html#hasReplyTool" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Reply<wbr/>Tool</span></a>
<a href="DsPdfViewer.html#hasUndoChanges" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>has<wbr/>Undo<wbr/>Changes</span></a>
<a href="DsPdfViewer.html#hideAnnotations" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>hide<wbr/>Annotations</span></a>
<a href="DsPdfViewer.html#highlightManager" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>highlight<wbr/>Manager</span></a>
<a href="DsPdfViewer.html#hostElement" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>host<wbr/>Element</span></a>
<a href="DsPdfViewer.html#isDocumentShared" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>is<wbr/>Document<wbr/>Shared</span></a>
<a href="DsPdfViewer.html#isEditModeSticked" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>is<wbr/>Edit<wbr/>Mode<wbr/>Sticked</span></a>
<a href="DsPdfViewer.html#isInEditorMode" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>is<wbr/>In<wbr/>Editor<wbr/>Mode</span></a>
<a href="DsPdfViewer.html#jsFormatFunctions" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>js<wbr/>Format<wbr/>Functions</span></a>
<a href="DsPdfViewer.html#language" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>language</span></a>
<a href="DsPdfViewer.html#layoutMode" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>layout<wbr/>Mode</span></a>
<a href="DsPdfViewer.html#leftSidebar" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>left<wbr/>Sidebar</span></a>
<a href="DsPdfViewer.html#logLevel" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>log<wbr/>Level</span></a>
<a href="DsPdfViewer.html#modificationsState" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>modifications<wbr/>State</span></a>
<a href="DsPdfViewer.html#onAfterAddAnnotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>After<wbr/>Add<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#onAfterOpen" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>After<wbr/>Open</span></a>
<a href="DsPdfViewer.html#onAfterRemoveAnnotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>After<wbr/>Remove<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#onAfterUpdateAnnotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>After<wbr/>Update<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#onBeforeAddAnnotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Before<wbr/>Add<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#onBeforeOpen" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Before<wbr/>Open</span></a>
<a href="DsPdfViewer.html#onBeforeRemoveAnnotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Before<wbr/>Remove<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#onBeforeUpdateAnnotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Before<wbr/>Update<wbr/>Annotation</span></a>
<a href="DsPdfViewer.html#onDocumentOpen" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Document<wbr/>Open</span></a>
<a href="DsPdfViewer.html#onDocumentProgress" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Document<wbr/>Progress</span></a>
<a href="DsPdfViewer.html#onDocumentViewOpen" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Document<wbr/>View<wbr/>Open</span></a>
<a href="DsPdfViewer.html#onError" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Error</span></a>
<a href="DsPdfViewer.html#onThemeChanged" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Theme<wbr/>Changed</span></a>
<a href="DsPdfViewer.html#onViewerStateChange" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>on<wbr/>Viewer<wbr/>State<wbr/>Change</span></a>
<a href="DsPdfViewer.html#optionalContentConfig" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>optional<wbr/>Content<wbr/>Config</span></a>
<a href="DsPdfViewer.html#options" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>options</span></a>
<a href="DsPdfViewer.html#pageCount" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>page<wbr/>Count</span></a>
<a href="DsPdfViewer.html#pageDecoration" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>page<wbr/>Decoration</span></a>
<a href="DsPdfViewer.html#pageDisplay" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>page<wbr/>Display</span></a>
<a href="DsPdfViewer.html#pageIndex" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>page<wbr/>Index</span></a>
<a href="DsPdfViewer.html#requiredSupportApiVersion" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>required<wbr/>Support<wbr/>Api<wbr/>Version</span></a>
<a href="DsPdfViewer.html#rightSidebar" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>right<wbr/>Sidebar</span></a>
<a href="DsPdfViewer.html#rotation" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>rotation</span></a>
<a href="DsPdfViewer.html#scrollView" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>scroll<wbr/>View</span></a>
<a href="DsPdfViewer.html#searcher" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>searcher</span></a>
<a href="DsPdfViewer.html#secondToolbar" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>second<wbr/>Toolbar</span></a>
<a href="DsPdfViewer.html#secondToolbarLayout" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>second<wbr/>Toolbar<wbr/>Layout</span></a>
<a href="DsPdfViewer.html#signToolStorage" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>sign<wbr/>Tool<wbr/>Storage</span></a>
<a href="DsPdfViewer.html#storage" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>storage</span></a>
<a href="DsPdfViewer.html#structureTree" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>structure<wbr/>Tree</span></a>
<a href="DsPdfViewer.html#supportApi" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>support<wbr/>Api</span></a>
<a href="DsPdfViewer.html#supportApiVersion" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>support<wbr/>Api<wbr/>Version</span></a>
<a href="DsPdfViewer.html#tempOnPanelChange" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>temp<wbr/>On<wbr/>Panel<wbr/>Change</span></a>
<a href="DsPdfViewer.html#toolbarLayout" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>toolbar<wbr/>Layout</span></a>
<a href="DsPdfViewer.html#undoCount" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>undo<wbr/>Count</span></a>
<a href="DsPdfViewer.html#undoIndex" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>undo<wbr/>Index</span></a>
<a href="DsPdfViewer.html#undoState" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>undo<wbr/>State</span></a>
<a href="DsPdfViewer.html#version" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>version</span></a>
<a href="DsPdfViewer.html#viewMode" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>view<wbr/>Mode</span></a>
<a href="DsPdfViewer.html#viewerPreferences" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>viewer<wbr/>Preferences</span></a>
<a href="DsPdfViewer.html#viewerState" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>viewer<wbr/>State</span></a>
<a href="DsPdfViewer.html#zoomMode" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>zoom<wbr/>Mode</span></a>
<a href="DsPdfViewer.html#zoomTarget" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>zoom<wbr/>Target</span></a>
<a href="DsPdfViewer.html#zoomValue" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>zoom<wbr/>Value</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Constructors</h3>
<div class="tsd-index-list"><a href="DsPdfViewer.html#constructor" class="tsd-index-link tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-512-text"></path></svg><span>constructor</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="DsPdfViewer.html#registeredFonts" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>registered<wbr/>Fonts</span></a>
<a href="DsPdfViewer.html#toggleSidebar" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>toggle<wbr/>Sidebar</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="findControl" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>find<wbr/>Control</span><a href="#findControl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="findControl.findControl-1">find<wbr/>Control<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="GcPdfViewer.html" class="tsd-signature-type" data-tsd-kind="Class">GcPdfViewer</a><a href="#findControl.findControl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the viewer instance using the host element or host element selector</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-2">DsPdfViewer</span><span class="hl-1">.</span><span class="hl-3">findControl</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>selector: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="GcPdfViewer.html" class="tsd-signature-type" data-tsd-kind="Class">GcPdfViewer</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#findControl">findControl</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Annotation</span><a href="#addAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addAnnotation.addAnnotation-1">add<wbr/>Annotation<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><a href="#addAnnotation.addAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Adds an annotation to a specified page.</p>
<ul>
<li>This method uses a lock to ensure that the annotation is added synchronously preventing concurrent modifications.</li>
<li>Requires SupportApi.</li>
</ul>
<h3>Returns</h3><ul>
<li>A promise resolving to an object
containing the page index and the added annotation.</li>
</ul>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Add the Square annotation to the first page when you open the document:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">annotationType:</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-5">// AnnotationTypeCode.SQUARE</span><br/><span class="hl-1"> </span><span class="hl-2">subtype:</span><span class="hl-1"> </span><span class="hl-4">"Square"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">borderStyle:</span><span class="hl-1"> { </span><span class="hl-2">width:</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-2">style:</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">color:</span><span class="hl-1"> [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-2">interiorColor:</span><span class="hl-1"> [</span><span class="hl-8">255</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-2">rect:</span><span class="hl-1"> [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">200</span><span class="hl-1">, </span><span class="hl-8">200</span><span class="hl-1">]</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">});</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Below is the sample how to copy field with name "field1" and put it to the second page programmatically:</span><br/><span class="hl-5">// Find field widget with name field1:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">resultData</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotation</span><span class="hl-1">(</span><span class="hl-4">"field1"</span><span class="hl-1">, {</span><span class="hl-2">findField:</span><span class="hl-1"> </span><span class="hl-4">'fieldName'</span><span class="hl-1">});</span><br/><span class="hl-5">// Clone field:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">clonedField</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">cloneAnnotation</span><span class="hl-1">(</span><span class="hl-2">resultData</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-2">annotation</span><span class="hl-1">);</span><br/><span class="hl-5">// Change field name property:</span><br/><span class="hl-2">clonedField</span><span class="hl-1">.</span><span class="hl-2">fieldName</span><span class="hl-1"> = </span><span class="hl-4">"field1Copy"</span><span class="hl-1">;</span><br/><span class="hl-5">// Add cloned field to the second page.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotation</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">clonedField</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Add the FileAttachment annotation to the first page when you open the document:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">annotationType:</span><span class="hl-1"> </span><span class="hl-8">17</span><span class="hl-1">, </span><span class="hl-5">// AnnotationTypeCode.FILEATTACHMENT</span><br/><span class="hl-1"> </span><span class="hl-2">subtype:</span><span class="hl-1"> </span><span class="hl-4">"FileAttachment"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">file:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">filename:</span><span class="hl-1"> </span><span class="hl-4">'attachment.png'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">content:</span><span class="hl-1"> </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Uint8Array</span><span class="hl-1">([</span><span class="hl-8">137</span><span class="hl-1">,</span><span class="hl-8">80</span><span class="hl-1">,</span><span class="hl-8">78</span><span class="hl-1">,</span><span class="hl-8">71</span><span class="hl-1">,</span><span class="hl-8">13</span><span class="hl-1">,</span><span class="hl-8">10</span><span class="hl-1">,</span><span class="hl-8">26</span><span class="hl-1">,</span><span class="hl-8">10</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">13</span><span class="hl-1">,</span><span class="hl-8">73</span><span class="hl-1">,</span><span class="hl-8">72</span><span class="hl-1">,</span><span class="hl-8">68</span><span class="hl-1">,</span><span class="hl-8">82</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">45</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">32</span><span class="hl-1">,</span><span class="hl-8">8</span><span class="hl-1">,</span><span class="hl-8">6</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">134</span><span class="hl-1">,</span><span class="hl-8">132</span><span class="hl-1">,</span><span class="hl-8">241</span><span class="hl-1">,</span><span class="hl-8">68</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">4</span><span class="hl-1">,</span><span class="hl-8">103</span><span class="hl-1">,</span><span class="hl-8">65</span><span class="hl-1">,</span><span class="hl-8">77</span><span class="hl-1">,</span><span class="hl-8">65</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">177</span><span class="hl-1">,</span><span class="hl-8">143</span><span class="hl-1">,</span><span class="hl-8">11</span><span class="hl-1">,</span><span class="hl-8">252</span><span class="hl-1">,</span><span class="hl-8">97</span><span class="hl-1">,</span><span class="hl-8">5</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">0</span><span class="hl-1">,</span><span class="hl-8">7</span><span class="hl-1">,</span><span class="hl-8">56</span><span class="hl-1">,</span><span class="hl-8">73</span><span class="hl-1">,</span><span class="hl-8">68</span><span class="hl-1">,</span><span class="hl-8">65</span><span class="hl-1">,</span><span class="hl-8">84</span><span class="hl-1">,</span><span class="hl-8">88</span><span class="hl-1">,</span><span class="hl-8">9</span><span class="hl-1">,</span><span class="hl-8">205</span><span class="hl-1">,</span><span class="hl-8">88</span><span class="hl-1">,</span><span class="hl-8">11</span><span class="hl-1">,</span><span class="hl-8">112</span><span class="hl-1">,</span><span class="hl-8">92</span><span class="hl-1">,</span><span class="hl-8">85</span><span class="hl-1">,</span><span class="hl-8">25</span><span class="hl-1">,</span><span class="hl-8">254</span><span class="hl-1">,</span><span class="hl-8">255</span><span class="hl-1">,</span><span class="hl-8">115</span><span class="hl-1">,</span><span class="hl-8">179</span><span class="hl-1">,</span><span class="hl-8">129</span><span class="hl-1">,</span><span class="hl-8">148</span><span class="hl-1">,</span><span class="hl-8">36</span><span class="hl-1">,</span><span class="hl-8">155</span><span class="hl-1">,</span><span class="hl-8">190</span><span class="hl-1">,</span><span class="hl-8">147</span><span class="hl-1">,</span><span class="hl-8">187</span><span class="hl-1">,</span><span class="hl-8">91</span><span class="hl-1">,</span><span class="hl-8">228</span><span class="hl-1">,</span><span class="hl-8">49</span><span class="hl-1">,</span><span class="hl-8">64</span><span class="hl-1">,</span><span class="hl-8">25</span><span class="hl-1">,</span><span class="hl-8">99</span><span class="hl-1">,</span><span class="hl-8">181</span><span class="hl-1">,</span><span class="hl-8">105</span><span class="hl-1">,</span><span class="hl-8">169</span><span class="hl-1">,</span><span class="hl-8">117</span><span class="hl-1">,</span><span class="hl-8">176</span><span class="hl-1">,</span><span class="hl-8">149</span><span class="hl-1">,</span><span class="hl-8">34</span><span class="hl-1">,</span><span class="hl-8">99</span><span class="hl-1">,</span><span class="hl-8">113</span><span class="hl-1">,</span><span class="hl-8">80</span><span class="hl-1">,</span><span class="hl-8">65</span><span class="hl-1">,</span><span class="hl-8">165</span><span class="hl-1">,</span><span class="hl-8">162</span><span class="hl-1">,</span><span class="hl-8">118</span><span class="hl-1">,</span><span class="hl-8">168</span><span class="hl-1">,</span><span class="hl-8">15</span><span class="hl-1">,</span><span class="hl-8">44</span><span class="hl-1">,</span><span class="hl-8">3</span><span class="hl-1">,</span><span class="hl-8">42</span><span class="hl-1">,</span><span class="hl-8">99</span><span class="hl-1">,</span><span class="hl-8">55</span><span class="hl-1">,</span><span class="hl-8">125</span><span class="hl-1">,</span><span class="hl-8">8</span><span class="hl-1">,</span><span class="hl-8">29</span><span class="hl-1">,</span><span class="hl-8">59</span><span class="hl-1">,</span><span class="hl-8">221</span><span class="hl-1">,</span><span class="hl-8">90</span><span class="hl-1">,</span><span class="hl-8">29</span><span class="hl-1">,</span><span class="hl-8">132</span><span class="hl-1">,</span><span class="hl-8">38</span><span class="hl-1">,</span><span class="hl-8">187</span><span class="hl-1">,</span><span class="hl-8">43</span><span class="hl-1">,</span><span class="hl-8">56</span><span class="hl-1">,</span><span class="hl-8">162</span><span class="hl-1">,</span><span class="hl-8">22</span><span class="hl-1">,</span><span class="hl-8">5</span><span class="hl-1">,</span><span class="hl-8">161</span><span class="hl-1">,</span><span class="hl-8">206</span><span class="hl-1">,</span><span class="hl-8">240</span><span class="hl-1">,</span><span class="hl-8">24</span><span class="hl-1">,</span><span class="hl-8">64</span><span class="hl-1">,</span><span class="hl-8">40</span><span class="hl-1">,</span><span class="hl-8">130</span><span class="hl-1">,</span><span class="hl-8">15</span><span class="hl-1">,</span><span class="hl-8">156</span><span class="hl-1">,</span><span class="hl-8">138</span><span class="hl-1">,</span><span class="hl-8">226</span><span class="hl-1">,</span><span class="hl-8">3</span><span class="hl-1">,</span><span class="hl-8">147</span><span class="hl-1">,</span><span class="hl-8">14</span><span class="hl-1">,</span><span class="hl-8">118</span><span class="hl-1">,</span><span class="hl-8">74</span><span class="hl-1">,</span><span class="hl-8">219</span><span class="hl-1">,</span><span class="hl-8">41</span><span class="hl-1">,</span><span class="hl-8">157</span><span class="hl-1">,</span><span class="hl-8">102</span><span class="hl-1">,</span><span class="hl-8">138</span><span class="hl-1">,</span><span class="hl-8">238</span><span class="hl-1">,</span><span class="hl-8">166</span><span class="hl-1">,</span><span class="hl-8">155</span><span class="hl-1">,</span><span class="hl-8">180</span><span class="hl-1">,</span><span class="hl-8">105</span><span class="hl-1">,</span><span class="hl-8">246</span><span class="hl-1">,</span><span class="hl-8">238</span><span class="hl-1">,</span><span class="hl-8">210</span><span class="hl-1">,</span><span class="hl-8">144</span><span class="hl-1">,</span><span class="hl-8">108</span><span class="hl-1">,</span><span class="hl-8">238</span><span class="hl-1">,</span><span class="hl-8">158</span><span class="hl-1">,</span><span class="hl-8">223</span><span class="hl-1">,</span><span class="hl-8">239</span><span class="hl-1">,</span><span class="hl-8">44</span><span class="hl-1">,</span><span class="hl-8">189</span><span class="hl-1">,</span><span class="hl-8">233</span><span class="hl-1">,</span><span class="hl-8">110</span><span class="hl-1">,</span><span class="hl-8">186</span><span class="hl-1">,</span><span class="hl-8">217</span><span class="hl-1">,</span><span class="hl-8">172</span><span class="hl-1">,</span><span class="hl-8">54</span><span class="hl-1">,</span><span class="hl-8">64</span><span class="hl-1">,</span><span class="hl-8">239</span><span class="hl-1">,</span><span class="hl-8">204</span><span class="hl-1">,</span><span class="hl-8">206</span><span class="hl-1">,</span><span class="hl-8">61</span><span class="hl-1">,</span><span class="hl-8">143</span><span class="hl-1">,</span><span class="hl-8">255</span><span class="hl-1">,</span><span class="hl-8">241</span><span class="hl-1">,</span><span class="hl-8">157</span><span class="hl-1">,</span><span class="hl-8">255</span><span class="hl-1">,</span><span class="hl-8">156</span><span class="hl-1">,</span><span class="hl-8">255</span><span class="hl-1">,</span><span class="hl-8">251</span><span class="hl-1">,</span><span class="hl-8">207</span><span class="hl-1">,</span><span class="hl-8">93</span><span class="hl-1">,</span><span class="hl-8">166</span><span class="hl-1">,</span><span class="hl-8">183</span><span class="hl-1">,</span><span class="hl-8">243</span><span class="hl-1">,</span><span class="hl-8">185</span><span class="hl-1">,</span><span class="hl-8">185</span><span class="hl-1">,</span><span class="hl-8">211</span><span class="hl-1">,</span><span class="hl-8">55</span><span class="hl-1">,</span><span class="hl-8">125</span><span class="hl-1">,</span><span class="hl-8">246</span><span class="hl-1">,</span><span class="hl-8">69</span><span class="hl-1">,</span><span class="hl-8">239</span><span class="hl-1">,</span><span class="hl-8">177</span><span class="hl-1">,</span><span class="hl-8">136</span><span class="hl-1">,</span><span class="hl-8">166</span><span class="hl-1">,</span><span class="hl-8">176</span><span class="hl-1">,</span><span class="hl-8">150</span><span class="hl-1">,</span><span class="hl-8">92</span><span class="hl-1">,</span><span class="hl-8">86</span><span class="hl-1">,</span><span class="hl-8">185</span><span class="hl-1">,</span><span class="hl-8">201</span><span class="hl-1">,</span><span class="hl-8">190</span><span class="hl-1">,</span><span class="hl-8">244</span><span class="hl-1">,</span><span class="hl-8">238</span><span class="hl-1">,</span><span class="hl-8">30</span><span class="hl-1">,</span><span class="hl-8">10</span><span class="hl-1">,</span><span class="hl-8">47</span><span class="hl-1">,</span><span class="hl-8">113</span><span class="hl-1">,</span><span class="hl-8">79</span><span class="hl-1">,</span><span class="hl-8">199</span><span class="hl-1">,</span><span class="hl-8">45</span><span class="hl-1">,</span><span class="hl-8">159</span><span class="hl-1">,</span><span class="hl-8">142</span><span class="hl-1">,</span><span class="hl-8">114</span><span class="hl-1">,</span><span class="hl-8">41</span><span class="hl-1">,</span><span class="hl-8">221</span><span class="hl-1">,</span><span class="hl-8">192</span><span class="hl-1">,</span><span class="hl-8">93</span><span class="hl-1">,</span><span class="hl-8">125</span><span class="hl-1">,</span><span class="hl-8">65</span><span class="hl-1">,</span><span class="hl-8">62</span><span class="hl-1">,</span><span class="hl-8">203</span><span class="hl-1">,</span><span class="hl-8">183</span><span class="hl-1">,</span><span class="hl-8">92</span><span class="hl-1">,</span><span class="hl-8">136</span><span class="hl-1">,</span><span class="hl-8">174</span><span class="hl-1">,</span><span class="hl-8">99</span><span class="hl-1">,</span><span class="hl-8">226</span><span class="hl-1">,</span><span class="hl-8">185</span><span class="hl-1">,</span><span class="hl-8">144</span><span class="hl-1">,</span><span class="hl-8">57</span><span class="hl-1">,</span><span class="hl-8">171</span><span class="hl-1">,</span><span class="hl-8">80</span><span class="hl-1">,</span><span class="hl-8">14</span><span class="hl-1">,</span><span class="hl-8">227</span><span class="hl-1">,</span><span class="hl-8">57</span><span class="hl-1">,</span><span class="hl-8">22</span><span class="hl-1">,</span><span class="hl-8">249</span><span class="hl-1">,</span><span class="hl-8">155</span><span class="hl-1">,</span><span class="hl-8">102</span><span class="hl-1">,</span><span class="hl-8">218</span><span class="hl-1">,</span><span class="hl-8">46</span><span class="hl-1">,</span><span class="hl-8">110</span><span class="hl-1">,</span><span class="hl-8">238</span><span class="hl-1">,</span><span class="hl-8">177</span><span class="hl-1">,</span><span class="hl-8">195</span><span class="hl-1">,</span><span class="hl-8">107</span><span class="hl-1">,</span><span class="hl-8">38</span><span class="hl-1">,</span><span class="hl-8">191</span><span class="hl-1">,</span><span class="hl-8">94</span><span class="hl-1">,</span><span class="hl-8">56</span><span class="hl-1">,</span><span class="hl-8">95</span><span class="hl-1">,</span><span class="hl-8">73</span><span class="hl-1">,</span><span class="hl-8">123</span><span class="hl-1">,</span><span class="hl-8">194</span><span class="hl-1">,</span><span class="hl-8">64</span><span class="hl-1">,</span><span class="hl-8">207</span><span class="hl-1">,</span><span class="hl-8">220</span><span class="hl-1">,</span><span class="hl-8">146</span><span class="hl-1">,</span><span class="hl-8">156</span><span class="hl-1">,</span><span class="hl-8">81</span><span class="hl-1">,</span><span class="hl-8">229</span><span class="hl-1">,</span><span class="hl-8">171</span><span class="hl-1">,</span><span class="hl-8">217</span><span class="hl-1">,</span><span class="hl-8">196</span><span class="hl-1">,</span><span class="hl-8">164</span><span class="hl-1">,</span><span class="hl-8">110</span><span class="hl-1">,</span><span class="hl-8">130</span><span class="hl-1">,</span><span class="hl-8">99</span><span class="hl-1">,</span><span class="hl-8">31</span><span class="hl-1">,</span><span class="hl-8">145</span><span class="hl-1">,</span><span class="hl-8">116</span><span class="hl-1">,</span><span class="hl-8">144</span><span class="hl-1">,</span><span class="hl-8">208</span><span class="hl-1">,</span><span class="hl-8">14</span><span class="hl-1">,</span><span class="hl-8">210</span><span class="hl-1">,</span><span class="hl-8">178</span><span class="hl-1">,</span><span class="hl-8">155</span><span class="hl-1">,</span><span class="hl-8">20</span><span class="hl-1">,</span><span class="hl-8">245</span><span class="hl-1">,</span><span class="hl-8">137</span><span class="hl-1">,</span><span class="hl-8">102</span><span class="hl-1">,</span><span class="hl-8">75</span><span class="hl-1">,</span><span class="hl-8">20</span><span class="hl-1">,</span><span class="hl-8">53</span><span class="hl-1">,</span><span class="hl-8">50</span><span class="hl-1">,</span><span class="hl-8">211</span><span class="hl-1">,</span><span class="hl-8">249</span><span class="hl-1">,</span><span class="hl-8">36</span><span class="hl-1">,</span><span class="hl-8">124</span><span class="hl-1">,</span><span class="hl-8">53</span><span class="hl-1">,</span><span class="hl-8">49</span><span class="hl-1">,</span><span class="hl-8">205</span><span class="hl-1">,</span><span class="hl-8">133</span><span class="hl-1">,</span><span class="hl-8">115</span><span class="hl-1">,</span><span class="hl-8">87</span><span class="hl-1">,</span><span class="hl-8">72</span><span class="hl-1">,</span><span class="hl-8">111</span><span class="hl-1">,</span><span class="hl-8">29</span><span class="hl-1">,</span><span class="hl-8">146</span><span class="hl-1">,</span><span class="hl-8">236</span><span class="hl-1">,</span><span class="hl-8">247</span><span class="hl-1">,</span><span class="hl-8">142</span><span class="hl-1">,</span><span class="hl-8">134</span><span class="hl-1">,</span><span class="hl-8">166</span><span class="hl-1">,</span><span class="hl-8">31</span><span class="hl-1">,</span><span class="hl-8">174</span><span class="hl-1">,</span><span class="hl-8">4</span><span class="hl-1">,</span><span class="hl-8">176</span><span class="hl-1">,</span><span class="hl-8">145</span><span class="hl-1">,</span><span class="hl-8">153</span><span class="hl-1">,</span><span class="hl-8">16</span><span class="hl-1">,</span><span class="hl-8">208</span><span class="hl-1">,</span><span class="hl-8">118</span><span class="hl-1">,</span><span class="hl-8">52</span><span class="hl-1">,</span><span class="hl-8">213</span><span class="hl-1">,</span><span class="hl-8">194</span><span class="hl-1">,</span><span class="hl-8">108</span><span class="hl-1">,</span><span class="hl-8">61</span><span class="hl-1">,</span><span class="hl-8">13</span><span class="hl-1">,</span><span class="hl-8">144</span><span class="hl-1">,</span><span class="hl-8">141</span><span class="hl-1">,</span><span class="hl-8">48</span><span class="hl-1">,</span><span class="hl-8">248</span><span class="hl-1">,</span><span class="hl-8">184</span><span class="hl-1">,</span><span class="hl-8">43</span><span class="hl-1">,</span><span class="hl-8">58</span><span class="hl-1">,</span><span class="hl-8">150</span><span class="hl-1">,</span><span class="hl-8">108</span><span class="hl-1">,</span><span class="hl-8">245</span><span class="hl-1">,</span><span class="hl-8">255</span><span class="hl-1">,</span><span class="hl-8">179</span><span class="hl-1">,</span><span class="hl-8">28</span><span class="hl-1">,</span><span class="hl-8">8</span><span class="hl-1">,</span><span class="hl-8">187</span><span class="hl-1">,</span><span class="hl-8">189</span><span class="hl-1">,</span><span class="hl-8">111</span><span class="hl-1">,</span><span class="hl-8">150</span><span class="hl-1">,</span><span class="hl-8">178</span><span class="hl-1">,</span><span class="hl-8">170</span><span class="hl-1">,</span><span class="hl-8">215</span><span class="hl-1">,</span><span class="hl-8">65</span><span class="hl-1">,</span><span class="hl-8">231</span><span class="hl-1">,</span><span class="hl-8">102</span><span class="hl-1">,</span><span class="hl-8">44</span><span class="hl-1">])</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">rect:</span><span class="hl-1"> [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">20</span><span class="hl-1">, </span><span class="hl-8">20</span><span class="hl-1">]</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The index of the page to which the annotation should be added.
Alternatively, an object with a property <code>pageIndex</code> specifying the page index.
This supports the override: addAnnotation({ pageIndex: 1 }, annotation, args).</p>
</div></li>
<li>
<h5>annotation: <a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5>
<div class="tsd-comment tsd-typography"><p>The annotation object to be added.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-symbol">{ </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>Additional optional arguments, such as skipping page refresh.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> skip<wbr/>Page<wbr/>Refresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addAnnotation">addAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addAnnotationEditorPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Annotation<wbr/>Editor<wbr/>Panel</span><a href="#addAnnotationEditorPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addAnnotationEditorPanel.addAnnotationEditorPanel-1">add<wbr/>Annotation<wbr/>Editor<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addAnnotationEditorPanel.addAnnotationEditorPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add annotation editor panel.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotationEditorPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addAnnotationEditorPanel">addAnnotationEditorPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addArticlesPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Articles<wbr/>Panel</span><a href="#addArticlesPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addArticlesPanel.addArticlesPanel-1">add<wbr/>Articles<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addArticlesPanel.addArticlesPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add articles panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addArticlesPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addArticlesPanel">addArticlesPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addAttachmentsPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Attachments<wbr/>Panel</span><a href="#addAttachmentsPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addAttachmentsPanel.addAttachmentsPanel-1">add<wbr/>Attachments<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addAttachmentsPanel.addAttachmentsPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add attachments panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAttachmentsPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addAttachmentsPanel">addAttachmentsPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addDefaultPanels" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Default<wbr/>Panels</span><a href="#addDefaultPanels" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addDefaultPanels.addDefaultPanels-1">add<wbr/>Default<wbr/>Panels<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><span class="tsd-signature-symbol">[]</span><a href="#addDefaultPanels.addDefaultPanels-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add default set of sidebar panels with default order:
'Thumbnails', 'Search', 'Outline', 'Layers', 'StructureTree', 'Attachments'</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addDefaultPanels">addDefaultPanels</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addDocumentListPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Document<wbr/>List<wbr/>Panel</span><a href="#addDocumentListPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addDocumentListPanel.addDocumentListPanel-1">add<wbr/>Document<wbr/>List<wbr/>Panel<span class="tsd-signature-symbol">(</span>documentListUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/DocumentListItem.html" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentListItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addDocumentListPanel.addDocumentListPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Adds document list panel to the Viewer with available document array specified
in documentslist.json file (URL specified by documentListUrl option), located in
the root directory of your application.
You can specify service at the end point for documentListUrl option.
The service should return JSON string with available documents array, e.g.: ["pdf1.pdf", "pdf2.pdf"]</p>
<h3>Example</h3><p>Example content for the documentslist.json file:</p>
<pre><code class="language-javascript"><span class="hl-1">[</span><span class="hl-4">"file1.pdf"</span><span class="hl-1">, </span><span class="hl-4">"file2.pdf"</span><span class="hl-1">].</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">, { </span><span class="hl-2">documentListUrl:</span><span class="hl-1"> </span><span class="hl-4">"/documentslist.json"</span><span class="hl-1"> });</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDocumentListPanel</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span><br/><span class="hl-5">// Add document list panel and specify documentListUrl option:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDocumentListPanel</span><span class="hl-1">(</span><span class="hl-4">'/documentslist.json'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span><br/><span class="hl-5">// Add document list panel and specify documentListUrl option using DATA URI:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDocumentListPanel</span><span class="hl-1">(</span><span class="hl-4">'data:,[{"path": "doc1.pdf"}, {"path": "doc2.pdf", "name": "Hello doc 2", "title": "title 2"}]'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> documentListUrl: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/DocumentListItem.html" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentListItem</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. Document list service URL or predefined list of document list items.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addDocumentListPanel">addDocumentListPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addFormEditorPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Form<wbr/>Editor<wbr/>Panel</span><a href="#addFormEditorPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addFormEditorPanel.addFormEditorPanel-1">add<wbr/>Form<wbr/>Editor<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addFormEditorPanel.addFormEditorPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add form editor panel.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">supportApi:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1"> } );</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addFormEditorPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addFormEditorPanel">addFormEditorPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addLayersPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Layers<wbr/>Panel</span><a href="#addLayersPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addLayersPanel.addLayersPanel-1">add<wbr/>Layers<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addLayersPanel.addLayersPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add optional content layers panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addLayersPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addLayersPanel">addLayersPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addOutlinePanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Outline<wbr/>Panel</span><a href="#addOutlinePanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addOutlinePanel.addOutlinePanel-1">add<wbr/>Outline<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addOutlinePanel.addOutlinePanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add outline panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addOutlinePanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addOutlinePanel">addOutlinePanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addReplyTool" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Reply<wbr/>Tool</span><a href="#addReplyTool" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addReplyTool.addReplyTool-1">add<wbr/>Reply<wbr/>Tool<span class="tsd-signature-symbol">(</span>sidebarState<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">GcRightSidebarState</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addReplyTool.addReplyTool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Enable the Text Annotation Reply Tool.
Note, in order to enable ability to edit/remove or add existing replies you need to configure SupportApi,
otherwise the Reply Tool will be in read-only mode.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addReplyTool</span><span class="hl-1">(</span><span class="hl-4">'expanded'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>sidebarState: <span class="tsd-signature-type">GcRightSidebarState</span><span class="tsd-signature-symbol"> = 'collapsed'</span></h5>
<div class="tsd-comment tsd-typography"><p>pass 'expanded' value if you wish the Reply tool to be expanded initially. Default value is collapsed.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addReplyTool">addReplyTool</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addSearchPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Search<wbr/>Panel</span><a href="#addSearchPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addSearchPanel.addSearchPanel-1">add<wbr/>Search<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addSearchPanel.addSearchPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add Search panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addSearchPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addSearchPanel">addSearchPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addSharedDocumentsPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Shared<wbr/>Documents<wbr/>Panel</span><a href="#addSharedDocumentsPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addSharedDocumentsPanel.addSharedDocumentsPanel-1">add<wbr/>Shared<wbr/>Documents<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addSharedDocumentsPanel.addSharedDocumentsPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add a panel with a list of shared documents.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addSharedDocumentsPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addSharedDocumentsPanel">addSharedDocumentsPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addStamp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Stamp</span><a href="#addStamp" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addStamp.addStamp-1">add<wbr/>Stamp<span class="tsd-signature-symbol">(</span>imageData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span>, args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>convertToContent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>rotate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>subject<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><a href="#addStamp.addStamp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add stamp annotation.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Add Graphical signature to the PDF using external image</span><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">addStampFromUrl</span><span class="hl-1">(</span><span class="hl-2">imageUrl</span><span class="hl-1">, </span><span class="hl-2">viewer</span><span class="hl-1">) {</span><br/><span class="hl-1"> * </span><span class="hl-3">fetch</span><span class="hl-1">(</span><span class="hl-2">imageUrl</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-2">response</span><span class="hl-1"> </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-2">response</span><span class="hl-1">.</span><span class="hl-3">blob</span><span class="hl-1">())</span><br/><span class="hl-1"> .</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-2">blob</span><span class="hl-1"> </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-2">blob</span><span class="hl-1">.</span><span class="hl-3">arrayBuffer</span><span class="hl-1">())</span><br/><span class="hl-1"> .</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-2">arrayBuffer</span><span class="hl-1"> </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">fileId</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Date</span><span class="hl-1">().</span><span class="hl-3">getTime</span><span class="hl-1">() + </span><span class="hl-4">".png"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">fileName</span><span class="hl-1"> = </span><span class="hl-2">fileId</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">imageData</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Uint8Array</span><span class="hl-1">(</span><span class="hl-2">arrayBuffer</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">rect</span><span class="hl-1"> = [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">200</span><span class="hl-1">, </span><span class="hl-8">200</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">storage</span><span class="hl-1">.</span><span class="hl-3">setItem</span><span class="hl-1">(</span><span class="hl-2">fileId</span><span class="hl-1">, </span><span class="hl-2">imageData</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addStamp</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">imageData</span><span class="hl-1">,</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">fileId</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fileName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">pageIndex</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">rect</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">select:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">subject:</span><span class="hl-1"> </span><span class="hl-4">""</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">rotate:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">convertToContent:</span><span class="hl-1"> </span><span class="hl-0">false</span><br/><span class="hl-1"> }); </span><br/><span class="hl-1"> });</span><br/><span class="hl-1">}</span><br/><span class="hl-5">// Usage:</span><br/><span class="hl-3">addStampFromUrl</span><span class="hl-1">(</span><span class="hl-4">"http://localhost/image.png"</span><span class="hl-1">, </span><span class="hl-2">viewer</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>imageData: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></h5>
<div class="tsd-comment tsd-typography"><p>Uint8Array, binary image data.</p>
</div></li>
<li>
<h5>args: <span class="tsd-signature-symbol">{ </span>convertToContent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>rotate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>subject<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> convert<wbr/>To<wbr/>Content<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5>file<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> file<wbr/>Name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5>page<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> rotate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> subject<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addStamp">addStamp</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addStickyNote" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Sticky<wbr/>Note</span><a href="#addStickyNote" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addStickyNote.addStickyNote-1">add<wbr/>Sticky<wbr/>Note<span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GcSelectionPoint</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addStickyNote.addStickyNote-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add sticky note to the document.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addStickyNote</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">toViewPortPoint</span><span class="hl-1">({</span><span class="hl-2">x:</span><span class="hl-1"> </span><span class="hl-8">50</span><span class="hl-1">, </span><span class="hl-2">y:</span><span class="hl-1"> </span><span class="hl-8">50</span><span class="hl-1">, </span><span class="hl-2">pageIndex:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">}));</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>position: <span class="tsd-signature-type">GcSelectionPoint</span></h5>
<div class="tsd-comment tsd-typography"><p>page relative point. Origin is top/left.
Note, pageIndex must be specified.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addStickyNote">addStickyNote</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addThumbnailsPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Thumbnails<wbr/>Panel</span><a href="#addThumbnailsPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addThumbnailsPanel.addThumbnailsPanel-1">add<wbr/>Thumbnails<wbr/>Panel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><a href="#addThumbnailsPanel.addThumbnailsPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add Thumbnails panel</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addThumbnailsPanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PanelHandle</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addThumbnailsPanel">addThumbnailsPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addViewAreaStyle" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>View<wbr/>Area<wbr/>Style</span><a href="#addViewAreaStyle" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="addViewAreaStyle.addViewAreaStyle-1">add<wbr/>View<wbr/>Area<wbr/>Style<span class="tsd-signature-symbol">(</span>cssText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#addViewAreaStyle.addViewAreaStyle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Adds a css style to the view area.</p>
<h3>Returns</h3><p>style element identifier.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Enable RTL text direction:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addViewAreaStyle</span><span class="hl-1">(</span><span class="hl-4">".gc-text-content, p, h1 { direction: rtl !important }"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>cssText: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#addViewAreaStyle">addViewAreaStyle</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="applyOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>apply<wbr/>Options</span><a href="#applyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="applyOptions.applyOptions-1">apply<wbr/>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyOptions.applyOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Call this method in order to apply changed options.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">options</span><span class="hl-1">.</span><span class="hl-2">zoomByMouseWheel</span><span class="hl-1"> = { </span><span class="hl-2">always:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">, </span><span class="hl-2">ctrlKey:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">, </span><span class="hl-2">metaKey:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> };</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyOptions</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#applyOptions">applyOptions</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="applyToolbarLayout" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>apply<wbr/>Toolbar<wbr/>Layout</span><a href="#applyToolbarLayout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="applyToolbarLayout.applyToolbarLayout-1">apply<wbr/>Toolbar<wbr/>Layout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyToolbarLayout.applyToolbarLayout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Call this method in order to apply changes in <a href="DsPdfViewer.html#toolbarLayout">toolbarLayout</a>.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyToolbarLayout</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-3">querySelector</span><span class="hl-1">(</span><span class="hl-4">"#viewer"</span><span class="hl-1">));</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">toolbar</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbar</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">toolbarLayout</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">toolbar</span><span class="hl-1">.</span><span class="hl-3">addItem</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">key:</span><span class="hl-1"> </span><span class="hl-4">'custom-add-stamp'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">icon:</span><span class="hl-1"> { </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-4">"svg"</span><span class="hl-1">, </span><span class="hl-2">content:</span><span class="hl-1"> </span><span class="hl-4">'<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path style="fill: #205F78;" d="M20.25 12l-2.25 2.25 2.25 2.25-3.75 3.75-2.25-2.25-2.25 2.25-2.25-2.25-2.25 2.25-3.75-3.75 2.25-2.25-2.25-2.25 2.25-2.25-2.25-2.25 3.75-3.75 2.25 2.25 2.25-2.25 2.25 2.25 2.25-2.25 3.75 3.75-2.25 2.25 2.25 2.25z"></path></svg>'</span><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-4">'Open your document to add a stamp'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">checked:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">, </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">action</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> () { </span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"Implement your action here."</span><span class="hl-1">); </span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-3">onUpdate</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> (</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">hasDoc</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasDocument</span><span class="hl-1"> && </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">state</span><span class="hl-1">.</span><span class="hl-2">session</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1"> > </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">return</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-2">hasDoc</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">checked:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-2">hasDoc</span><span class="hl-1"> ? </span><span class="hl-4">'Add stamp'</span><span class="hl-1"> : </span><span class="hl-4">'Open your document to add a stamp'</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1">.</span><span class="hl-3">splice</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-4">"custom-add-stamp"</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyToolbarLayout</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#applyToolbarLayout">applyToolbarLayout</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="applyViewPortScale" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>apply<wbr/>View<wbr/>Port<wbr/>Scale</span><a href="#applyViewPortScale" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="applyViewPortScale.applyViewPortScale-1">apply<wbr/>View<wbr/>Port<wbr/>Scale<span class="tsd-signature-symbol">(</span>rectOrCoords<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IGcRect</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span>, pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, srcOrigin<span class="tsd-signature-symbol">??: </span><span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IGcRect</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#applyViewPortScale.applyViewPortScale-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Scales the provided rectangle or coordinate array based on the current viewport scale.</p>
<p>This method accepts either an <code>IGcRect</code> object or an array of coordinates <code>[x1, y1, x2, y2]</code>.
It returns the scaled coordinates in the same format as the input.</p>
<p><strong>Note:</strong> This method changes the origin of the coordinates from "BottomLeft" (PDF default)
to "TopLeft" (canvas default). This transformation makes the coordinates ready for use in
drawing on a canvas, for example, in custom highlight rendering.</p>
<h3>Returns</h3><ul>
<li>The scaled rectangle or coordinate array, with origin set to "TopLeft".</li>
</ul>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Using an IGcRect object</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">rect</span><span class="hl-1"> = { </span><span class="hl-2">x:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1">, </span><span class="hl-2">y:</span><span class="hl-1"> </span><span class="hl-8">150</span><span class="hl-1">, </span><span class="hl-2">w:</span><span class="hl-1"> </span><span class="hl-8">200</span><span class="hl-1">, </span><span class="hl-2">h:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1"> };</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">scaledRect</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyViewPortScale</span><span class="hl-1">(</span><span class="hl-2">rect</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">);</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">scaledRect</span><span class="hl-1">); </span><span class="hl-5">// { x: scaledX, y: scaledY, w: scaledW, h: scaledH }</span>
</code></pre>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Using an array of coordinates [x1, y1, x2, y2]</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">coords</span><span class="hl-1"> = [</span><span class="hl-8">100</span><span class="hl-1">, </span><span class="hl-8">150</span><span class="hl-1">, </span><span class="hl-8">300</span><span class="hl-1">, </span><span class="hl-8">250</span><span class="hl-1">];</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">scaledCoords</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyViewPortScale</span><span class="hl-1">(</span><span class="hl-2">coords</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">);</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">scaledCoords</span><span class="hl-1">); </span><span class="hl-5">// [scaledX1, scaledY1, scaledX2, scaledY2]</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rectOrCoords: <span class="tsd-signature-type">IGcRect</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h5>
<div class="tsd-comment tsd-typography"><p>The rectangle object or array of coordinates to scale.</p>
</div></li>
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The index of the page for which the viewport scale should be applied.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> srcOrigin: <span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span><span class="tsd-signature-symbol"> = "BottomLeft"</span></h5>
<div class="tsd-comment tsd-typography"><p>The origin of the source coordinates.
"BottomLeft" origin is the PDF default, "TopLeft" is the canvas default.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IGcRect</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#applyViewPortScale">applyViewPortScale</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="bringPanelToFront" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>bring<wbr/>Panel<wbr/>To<wbr/>Front</span><a href="#bringPanelToFront" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="bringPanelToFront.bringPanelToFront-1">bring<wbr/>Panel<wbr/>To<wbr/>Front<span class="tsd-signature-symbol">(</span>panelKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#bringPanelToFront.bringPanelToFront-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<h3>Deprecated</h3><p>use expandPanel() instead</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>panelKey: <span class="tsd-signature-type">PanelHandle</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#bringPanelToFront">bringPanelToFront</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="changeBoundsOrigin" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>change<wbr/>Bounds<wbr/>Origin</span><a href="#changeBoundsOrigin" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="changeBoundsOrigin.changeBoundsOrigin-1">change<wbr/>Bounds<wbr/>Origin<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bounds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, srcOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span>, destOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span>, normalize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#changeBoundsOrigin.changeBoundsOrigin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>This method changes coordinate system origin for rectangle given by parameter
bounds and returns converted rectangle value;</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">topLeftBounds</span><span class="hl-1"> = [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">200</span><span class="hl-1">, </span><span class="hl-8">40</span><span class="hl-1">];</span><br/><span class="hl-5">// Convert the topLeftBounds from TopLeft origin to BottomLeft origin </span><br/><span class="hl-5">// taking into account the viewport from the first page and store </span><br/><span class="hl-5">// the result in the bottomLeftBounds variable:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">bottomLeftBounds</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">changeBoundsOrigin</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, </span><span class="hl-2">topLeftBounds</span><span class="hl-1">, </span><span class="hl-4">'TopLeft'</span><span class="hl-1">, </span><span class="hl-4">'BottomLeft'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Gets the bounds of the annotation relative to the viewport:</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">viewPort</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getViewPort</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">annotationRect</span><span class="hl-1"> = (</span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotation</span><span class="hl-1">(</span><span class="hl-4">'10R'</span><span class="hl-1">))[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-2">annotation</span><span class="hl-1">.</span><span class="hl-2">rect</span><span class="hl-1">;</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">invertedRect</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">changeBoundsOrigin</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, </span><span class="hl-2">annotationRect</span><span class="hl-1">, </span><span class="hl-4">'BottomLeft'</span><span class="hl-1">, </span><span class="hl-4">'TopLeft'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">annotationX1</span><span class="hl-1"> = </span><span class="hl-2">invertedRect</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">] * </span><span class="hl-2">viewPort</span><span class="hl-1">.</span><span class="hl-2">scale</span><span class="hl-1">;</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">annotationY1</span><span class="hl-1"> = </span><span class="hl-2">invertedRect</span><span class="hl-1">[</span><span class="hl-8">1</span><span class="hl-1">] * </span><span class="hl-2">viewPort</span><span class="hl-1">.</span><span class="hl-2">scale</span><span class="hl-1">;</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">annotationX2</span><span class="hl-1"> = </span><span class="hl-2">invertedRect</span><span class="hl-1">[</span><span class="hl-8">2</span><span class="hl-1">] * </span><span class="hl-2">viewPort</span><span class="hl-1">.</span><span class="hl-2">scale</span><span class="hl-1">;</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">annotationY2</span><span class="hl-1"> = </span><span class="hl-2">invertedRect</span><span class="hl-1">[</span><span class="hl-8">3</span><span class="hl-1">] * </span><span class="hl-2">viewPort</span><span class="hl-1">.</span><span class="hl-2">scale</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Page index (Zero based).</p>
</div></li>
<li>
<h5>bounds: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>bounds array: [x1, y1, x2, y2]</p>
</div></li>
<li>
<h5>srcOrigin: <span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span></h5>
<div class="tsd-comment tsd-typography"><p>Source coordinate system origin. Possible values are: 'TopLeft' or 'BottomLeft'.</p>
</div></li>
<li>
<h5>destOrigin: <span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span></h5>
<div class="tsd-comment tsd-typography"><p>Destination coordinate system origin. Possible values are: 'TopLeft' or 'BottomLeft'.</p>
</div></li>
<li>
<h5>normalize: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. Default is true. Normalize rectangle [x1, y1, x2, y2] so that (x1,y1) < (x2,y2).</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#changeBoundsOrigin">changeBoundsOrigin</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="changeOrigin" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>change<wbr/>Origin</span><a href="#changeOrigin" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="changeOrigin.changeOrigin-1">change<wbr/>Origin<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, srcOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span>, destOrigin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#changeOrigin.changeOrigin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>This method changes coordinate system origin for y coordinate given by parameter
y and returns converted value.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">y</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-5">// Convert from TopLeft origin to BottomLeft origin</span><br/><span class="hl-5">// taking into account the viewport from the first page:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">yBottom</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">changeOrigin</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, </span><span class="hl-2">y</span><span class="hl-1">, </span><span class="hl-4">'TopLeft'</span><span class="hl-1">, </span><span class="hl-4">'BottomLeft'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>y: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>srcOrigin: <span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span></h5></li>
<li>
<h5>destOrigin: <span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#changeOrigin">changeOrigin</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="changeOriginToBottom" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>change<wbr/>Origin<wbr/>To<wbr/>Bottom</span><a href="#changeOriginToBottom" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="changeOriginToBottom.changeOriginToBottom-1">change<wbr/>Origin<wbr/>To<wbr/>Bottom<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#changeOriginToBottom.changeOriginToBottom-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Converts the origin of the Y coordinate to the bottom.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">y</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-5">// Convert y value from TopLeft origin to BottomLeft origin</span><br/><span class="hl-5">// taking into account the viewport from the first page:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">yBottom</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">changeOriginToBottom</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, </span><span class="hl-2">y</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">any</span></h5></li>
<li>
<h5>y: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#changeOriginToBottom">changeOriginToBottom</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="changeOriginToTop" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>change<wbr/>Origin<wbr/>To<wbr/>Top</span><a href="#changeOriginToTop" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="changeOriginToTop.changeOriginToTop-1">change<wbr/>Origin<wbr/>To<wbr/>Top<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#changeOriginToTop.changeOriginToTop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Converts the origin of the Y coordinate to the top.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">y</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-5">// Convert y value from BottomLeft origin to TopLeft origin</span><br/><span class="hl-5">// taking into account the viewport from the first page:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">yTop</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">changeOriginToTop</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, </span><span class="hl-2">y</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">any</span></h5></li>
<li>
<h5>y: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#changeOriginToTop">changeOriginToTop</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="clearHighlightedSegments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>clear<wbr/>Highlighted<wbr/>Segments</span><a href="#clearHighlightedSegments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="clearHighlightedSegments.clearHighlightedSegments-1">clear<wbr/>Highlighted<wbr/>Segments<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">HighlightBehaviorArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearHighlightedSegments.clearHighlightedSegments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Clears all highlights from one or more specific pages.</p>
<p>This method removes all custom highlights from the specified pages. You can pass either a single page index or an array of page indices.</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Clear highlights from page 2:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">clearHighlightedSegments</span><span class="hl-1">(</span><span class="hl-8">2</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Clear highlights from pages 1, 3, and 5:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">clearHighlightedSegments</span><span class="hl-1">([</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">]);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>The index of the page or an array of page indices from which to clear highlights.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-type">HighlightBehaviorArgs</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional behavior arguments, such as whether to skip repainting the text layer after clearing highlights.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#clearHighlightedSegments">clearHighlightedSegments</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="cloneAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>clone<wbr/>Annotation</span><a href="#cloneAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="cloneAnnotation.cloneAnnotation-1">clone<wbr/>Annotation<span class="tsd-signature-symbol">(</span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><a href="#cloneAnnotation.cloneAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Clone annotation or field given by parameter annotation.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Below is the sample how to copy field with name "field1" and put it to the second page programmatically:</span><br/><span class="hl-5">// Find field widget with name field1:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">resultData</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotation</span><span class="hl-1">(</span><span class="hl-4">"field1"</span><span class="hl-1">, {</span><span class="hl-2">findField:</span><span class="hl-1"> </span><span class="hl-4">'fieldName'</span><span class="hl-1">});</span><br/><span class="hl-5">// Clone field:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">clonedField</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">cloneAnnotation</span><span class="hl-1">(</span><span class="hl-2">resultData</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-2">annotation</span><span class="hl-1">);</span><br/><span class="hl-5">// Change field name property:</span><br/><span class="hl-2">clonedField</span><span class="hl-1">.</span><span class="hl-2">fieldName</span><span class="hl-1"> = </span><span class="hl-4">"field1Copy"</span><span class="hl-1">;</span><br/><span class="hl-5">// Add cloned field to the second page.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotation</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">clonedField</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>annotation: <a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5>
<div class="tsd-comment tsd-typography"><p>Annotation to clone.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#cloneAnnotation">cloneAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="close" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="close.close-1">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#close.close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Closes the currently open document.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">close</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#close">close</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="closePanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>close<wbr/>Panel</span><a href="#closePanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="closePanel.closePanel-1">close<wbr/>Panel<span class="tsd-signature-symbol">(</span>panelHandleOrId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PanelHandle</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#closePanel.closePanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Closes the side panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">closePanel</span><span class="hl-1">();</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> panelHandleOrId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PanelHandle</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. Panel handle or panel id to close.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#closePanel">closePanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="collectQuadPoints" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>collect<wbr/>Quad<wbr/>Points</span><a href="#collectQuadPoints" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="collectQuadPoints.collectQuadPoints-1">collect<wbr/>Quad<wbr/>Points<span class="tsd-signature-symbol">(</span>paintedBoxes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PaintedBoxInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TextPartsQuadPoints</span><a href="#collectQuadPoints.collectQuadPoints-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Collects quadrilateral points based on the provided PaintedBoxInfo array.</p>
<h3>Returns</h3><ul>
<li>Information about selected or highlighted text fragments, including
the page index, outer rectangle coordinates, and quadrilateral points.</li>
</ul>
<h3>Description</h3><p>This method takes an array of PaintedBoxInfo objects, where each object contains information about a painted box
on a PDF page. It calculates the outer rectangle coordinates and quadrilateral points for the selected or highlighted text fragments.
The coordinates have their origin at the bottom-left corner as per PDF specifications.</p>
<p>The quadPoints array is sorted as follows:
[{ x: minX, y: maxY },
{ x: maxX, y: maxY },
{ x: minX, y: minY },
{ x: maxX, y: minY }]</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>paintedBoxes: <span class="tsd-signature-type">PaintedBoxInfo</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>An array of PaintedBoxInfo objects representing painted boxes on a PDF page.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TextPartsQuadPoints</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#collectQuadPoints">collectQuadPoints</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="confirm" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>confirm</span><a href="#confirm" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="confirm.confirm-1">confirm<span class="tsd-signature-symbol">(</span>confirmationText<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span>, level<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"warning"</span>, title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, buttons<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ConfirmButton</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ConfirmButton</span><span class="tsd-signature-symbol">></span><a href="#confirm.confirm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Display confirmation dialog.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">confirmResult</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">confirm</span><span class="hl-1">(</span><span class="hl-4">"Apply changes?"</span><span class="hl-1">, </span><span class="hl-4">"info"</span><span class="hl-1">, </span><span class="hl-4">"Confirm action"</span><span class="hl-1">, [</span><span class="hl-4">"Yes"</span><span class="hl-1">, </span><span class="hl-4">"No"</span><span class="hl-1">, </span><span class="hl-4">"Cancel"</span><span class="hl-1">]);</span><br/><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">confirmResult</span><span class="hl-1"> === </span><span class="hl-4">"Yes"</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// put your code here</span><br/><span class="hl-1">} </span><span class="hl-7">else</span><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">confirmResult</span><span class="hl-1"> === </span><span class="hl-4">"No"</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// put your code here</span><br/><span class="hl-1">} </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">// put your code here</span><br/><span class="hl-1">} </span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> confirmationText: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> level: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"warning"</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> title: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> buttons: <span class="tsd-signature-type">ConfirmButton</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ConfirmButton</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#confirm">confirm</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="convertPdfRectToWindowCoordinates" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>convert<wbr/>Pdf<wbr/>Rect<wbr/>To<wbr/>Window<wbr/>Coordinates</span><a href="#convertPdfRectToWindowCoordinates" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="convertPdfRectToWindowCoordinates.convertPdfRectToWindowCoordinates-1">convert<wbr/>Pdf<wbr/>Rect<wbr/>To<wbr/>Window<wbr/>Coordinates<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Rect</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#convertPdfRectToWindowCoordinates.convertPdfRectToWindowCoordinates-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Converts PDF rectangle or PDF point coordinates to absolute window coordinates.</p>
<h3>Returns</h3><p>Array of window coordinates corresponding to the given PDF coordinates.</p>
<h3>Throws</h3><p>Error if the coordinates format is incorrect. Expected either [x, y] or [x1, y1, x2, y2].</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Index of the PDF page.</p>
</div></li>
<li>
<h5>rect: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Rect</span></h5>
<div class="tsd-comment tsd-typography"><p>Array of coordinates [x1, y1, x2, y2] or [x, y], where (x1, y1) represents the bottom-left corner, and (x2, y2) represents the top-right corner.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#convertPdfRectToWindowCoordinates">convertPdfRectToWindowCoordinates</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="deletePage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>delete<wbr/>Page</span><a href="#deletePage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="deletePage.deletePage-1">delete<wbr/>Page<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deletePage.deletePage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Delete page.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Delete page with index 3.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">deletePage</span><span class="hl-1">(</span><span class="hl-8">3</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>page index to delete.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#deletePage">deletePage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="dispose" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>dispose</span><a href="#dispose" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="dispose.dispose-1">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#dispose.dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Use this method to close and release resources occupied by the DsPdfViewer.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#dispose">dispose</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="download" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>download</span><a href="#download" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="download.download-1">download<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#download.download-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Downloads the PDF document loaded in the Viewer to the local disk.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">download</span><span class="hl-1">();</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> fileName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>the destination file name.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#download">download</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="execCopyAction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>exec<wbr/>Copy<wbr/>Action</span><a href="#execCopyAction" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="execCopyAction.execCopyAction-1">exec<wbr/>Copy<wbr/>Action<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CopyBufferData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#execCopyAction.execCopyAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Execute Copy action (Ctrl + C shortcut).
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">execCopyAction</span><span class="hl-1">();</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> buffer: <span class="tsd-signature-type">CopyBufferData</span></h5>
<div class="tsd-comment tsd-typography"><p>data to copy.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#execCopyAction">execCopyAction</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="execCutAction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>exec<wbr/>Cut<wbr/>Action</span><a href="#execCutAction" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="execCutAction.execCutAction-1">exec<wbr/>Cut<wbr/>Action<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CopyBufferData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#execCutAction.execCutAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Execute Cut action (Ctrl + X shortcut).
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">execCutAction</span><span class="hl-1">();</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> buffer: <span class="tsd-signature-type">CopyBufferData</span></h5>
<div class="tsd-comment tsd-typography"><p>data to cut.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#execCutAction">execCutAction</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="execDeleteAction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>exec<wbr/>Delete<wbr/>Action</span><a href="#execDeleteAction" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="execDeleteAction.execDeleteAction-1">exec<wbr/>Delete<wbr/>Action<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CopyBufferData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#execDeleteAction.execDeleteAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Execute Delete action (DEL shortcut).
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">execDeleteAction</span><span class="hl-1">();</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> buffer: <span class="tsd-signature-type">CopyBufferData</span></h5>
<div class="tsd-comment tsd-typography"><p>data to delete.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#execDeleteAction">execDeleteAction</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="execPasteAction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>exec<wbr/>Paste<wbr/>Action</span><a href="#execPasteAction" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="execPasteAction.execPasteAction-1">exec<wbr/>Paste<wbr/>Action<span class="tsd-signature-symbol">(</span>point<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">GcSelectionPoint</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#execPasteAction.execPasteAction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Execute Paste action (Ctrl + V shortcut).
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasCopyData</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">execPasteAction</span><span class="hl-1">({</span><span class="hl-2">x:</span><span class="hl-1"> </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-2">y:</span><span class="hl-1"> </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-2">pageIndex:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">});</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> point: <span class="tsd-signature-type">GcSelectionPoint</span></h5>
<div class="tsd-comment tsd-typography"><p>insert position.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#execPasteAction">execPasteAction</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="executeTask" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>execute<wbr/>Task</span><a href="#executeTask" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="executeTask.executeTask-1">execute<wbr/>Task<span class="tsd-signature-symbol">(</span>task<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>callbacks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TaskCallbacks</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, settings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TaskSettings</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#executeTask.executeTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Starts long-running operation and displays progress window while operation is running.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>task: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>callbacks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TaskCallbacks</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>callbacks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TaskCallbacks</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>callbacks: <span class="tsd-signature-type">TaskCallbacks</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> settings: <span class="tsd-signature-type">TaskSettings</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#executeTask">executeTask</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="findAnnotations" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>find<wbr/>Annotations</span><a href="#findAnnotations" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="findAnnotations.findAnnotations-1">find<wbr/>Annotations<span class="tsd-signature-symbol">(</span>findString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, findParams<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>findAll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>findField<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pageIndexConstraint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#findAnnotations.findAnnotations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Find annotation(s) within opened document. Returns promise which will be resolved with search results.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Find annotation with id '2R':</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotations</span><span class="hl-1">(</span><span class="hl-4">"2R"</span><span class="hl-1">).</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">dataArray</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">dataArray</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">])</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">`Annotation </span><span class="hl-0">${</span><span class="hl-2">dataArray</span><span class="hl-10">[</span><span class="hl-8">0</span><span class="hl-10">].</span><span class="hl-2">annotation</span><span class="hl-10">.</span><span class="hl-2">id</span><span class="hl-0">}</span><span class="hl-4"> found on page with index </span><span class="hl-0">${</span><span class="hl-2">dataArray</span><span class="hl-10">[</span><span class="hl-8">0</span><span class="hl-10">].</span><span class="hl-2">pageIndex</span><span class="hl-0">}</span><span class="hl-4">.`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">else</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">'Annotation not found.'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// find all fields with name field1:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotations</span><span class="hl-1">(</span><span class="hl-4">"field1"</span><span class="hl-1">, {</span><span class="hl-2">findField:</span><span class="hl-1"> </span><span class="hl-4">'fieldName'</span><span class="hl-1">, </span><span class="hl-2">findAll:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">}).</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">dataArray</span><span class="hl-1">) {</span><br/><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>findString: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Find query.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> findParams: <span class="tsd-signature-symbol">{ </span>findAll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>findField<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pageIndexConstraint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>Find parameters. By default annotation will be searched by id without page index constraint.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> find<wbr/>All<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> find<wbr/>Field<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> page<wbr/>Index<wbr/>Constraint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#findAnnotations">findAnnotations</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getDocumentInformation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Document<wbr/>Information</span><a href="#getDocumentInformation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getDocumentInformation.getDocumentInformation-1">get<wbr/>Document<wbr/>Information<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentInformation</span><span class="tsd-signature-symbol">></span><a href="#getDocumentInformation.getDocumentInformation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets meta data information for the current document.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">docMetaInfo</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getDocumentInformation</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentInformation</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getDocumentInformation">getDocumentInformation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getDocumentSecurity" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Document<wbr/>Security</span><a href="#getDocumentSecurity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getDocumentSecurity.getDocumentSecurity-1">get<wbr/>Document<wbr/>Security<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentSecuritySummary</span><span class="tsd-signature-symbol">></span><a href="#getDocumentSecurity.getDocumentSecurity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets security information for the current document.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">docSecurityInfo</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getDocumentSecurity</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentSecuritySummary</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getDocumentSecurity">getDocumentSecurity</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getEvent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Event</span><a href="#getEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getEvent.getEvent-1">get<wbr/>Event<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getEvent.getEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get event object.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getEvent</span><span class="hl-1">(</span><span class="hl-4">"BeforeAddAnnotation"</span><span class="hl-1">).</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getEvent</span><span class="hl-1">(</span><span class="hl-4">"AfterAddAnnotation"</span><span class="hl-1">).</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>eventName: <span class="tsd-signature-type">EventName</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getEvent">getEvent</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getPageLocation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Page<wbr/>Location</span><a href="#getPageLocation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getPageLocation.getPageLocation-1">get<wbr/>Page<wbr/>Location<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><a href="#getPageLocation.getPageLocation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns position of the page view relative to the browser window.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageLocation</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageLocation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'The first page location is '</span><span class="hl-1"> + </span><span class="hl-2">location</span><span class="hl-1">.</span><span class="hl-2">x</span><span class="hl-1"> + </span><span class="hl-4">', '</span><span class="hl-1"> + </span><span class="hl-2">location</span><span class="hl-1">.</span><span class="hl-2">y</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Draws a red rectangle over the annotation with id "10R".</span><br/><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">, </span><span class="hl-2">annotationId</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">pageLocation</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageLocation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">), </span><span class="hl-6">viewPort</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getViewPort</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">), </span><br/><span class="hl-1"> </span><span class="hl-6">scale</span><span class="hl-1"> = </span><span class="hl-2">viewPort</span><span class="hl-1">.</span><span class="hl-2">scale</span><span class="hl-1">, </span><span class="hl-6">viewBox</span><span class="hl-1"> = </span><span class="hl-2">viewPort</span><span class="hl-1">.</span><span class="hl-2">viewBox</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">rect</span><span class="hl-1"> = (</span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotation</span><span class="hl-1">(</span><span class="hl-2">annotationId</span><span class="hl-1">))[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-2">annotation</span><span class="hl-1">.</span><span class="hl-2">rect</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">x1</span><span class="hl-1"> = </span><span class="hl-2">rect</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">] * </span><span class="hl-2">scale</span><span class="hl-1"> + </span><span class="hl-2">pageLocation</span><span class="hl-1">.</span><span class="hl-2">x</span><span class="hl-1">, </span><span class="hl-6">x2</span><span class="hl-1"> = </span><span class="hl-2">rect</span><span class="hl-1">[</span><span class="hl-8">2</span><span class="hl-1">] * </span><span class="hl-2">scale</span><span class="hl-1"> + </span><span class="hl-2">pageLocation</span><span class="hl-1">.</span><span class="hl-2">x</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">y1</span><span class="hl-1"> = (</span><span class="hl-2">viewBox</span><span class="hl-1">[</span><span class="hl-8">3</span><span class="hl-1">] - </span><span class="hl-2">rect</span><span class="hl-1">[</span><span class="hl-8">3</span><span class="hl-1">]) * </span><span class="hl-2">scale</span><span class="hl-1"> + </span><span class="hl-2">pageLocation</span><span class="hl-1">.</span><span class="hl-2">y</span><span class="hl-1">, </span><span class="hl-6">y2</span><span class="hl-1"> = (</span><span class="hl-2">viewBox</span><span class="hl-1">[</span><span class="hl-8">3</span><span class="hl-1">] - </span><span class="hl-2">rect</span><span class="hl-1">[</span><span class="hl-8">1</span><span class="hl-1">]) * </span><span class="hl-2">scale</span><span class="hl-1"> + </span><span class="hl-2">pageLocation</span><span class="hl-1">.</span><span class="hl-2">y</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">div</span><span class="hl-1"> = </span><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-3">createElement</span><span class="hl-1">(</span><span class="hl-4">'div'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">div</span><span class="hl-1">.</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">position</span><span class="hl-1"> = </span><span class="hl-4">'absolute'</span><span class="hl-1">; </span><br/><span class="hl-1"> </span><span class="hl-2">div</span><span class="hl-1">.</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">left</span><span class="hl-1"> = </span><span class="hl-4">`</span><span class="hl-0">${</span><span class="hl-2">x1</span><span class="hl-0">}</span><span class="hl-4">px`</span><span class="hl-1">; </span><span class="hl-2">div</span><span class="hl-1">.</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">top</span><span class="hl-1"> = </span><span class="hl-4">`</span><span class="hl-0">${</span><span class="hl-2">y1</span><span class="hl-0">}</span><span class="hl-4">px`</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">div</span><span class="hl-1">.</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">width</span><span class="hl-1"> = </span><span class="hl-4">`</span><span class="hl-0">${</span><span class="hl-2">x2</span><span class="hl-10"> </span><span class="hl-1">-</span><span class="hl-10"> </span><span class="hl-2">x1</span><span class="hl-0">}</span><span class="hl-4">px`</span><span class="hl-1">; </span><span class="hl-2">div</span><span class="hl-1">.</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">height</span><span class="hl-1"> = </span><span class="hl-4">`</span><span class="hl-0">${</span><span class="hl-2">y2</span><span class="hl-10"> </span><span class="hl-1">-</span><span class="hl-10"> </span><span class="hl-2">y1</span><span class="hl-0">}</span><span class="hl-4">px`</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">div</span><span class="hl-1">.</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">border</span><span class="hl-1"> = </span><span class="hl-4">'1px solid red'</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-2">body</span><span class="hl-1">.</span><span class="hl-3">appendChild</span><span class="hl-1">(</span><span class="hl-2">div</span><span class="hl-1">);</span><br/><span class="hl-1">})(</span><span class="hl-2">viewer</span><span class="hl-1">, </span><span class="hl-4">"10R"</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Add text annotation on mouse click</span><br/><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-3">addEventListener</span><span class="hl-1">(</span><span class="hl-4">"click"</span><span class="hl-1">, (</span><span class="hl-2">e</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">target</span><span class="hl-1"> = (</span><span class="hl-2">e</span><span class="hl-1">[</span><span class="hl-4">"path"</span><span class="hl-1">] || (</span><span class="hl-2">e</span><span class="hl-1">[</span><span class="hl-4">"composedPath"</span><span class="hl-1">] && </span><span class="hl-2">e</span><span class="hl-1">[</span><span class="hl-4">"composedPath"</span><span class="hl-1">]()) || [])[</span><span class="hl-8">0</span><span class="hl-1">] || </span><span class="hl-2">e</span><span class="hl-1">.</span><span class="hl-2">target</span><span class="hl-1">, </span><span class="hl-6">page</span><span class="hl-1"> = </span><span class="hl-2">target</span><span class="hl-1">.</span><span class="hl-3">closest</span><span class="hl-1">(</span><span class="hl-4">".page"</span><span class="hl-1">); </span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">target</span><span class="hl-1">.</span><span class="hl-3">closest</span><span class="hl-1">(</span><span class="hl-4">".gc-annotation"</span><span class="hl-1">)) </span><br/><span class="hl-1"> </span><span class="hl-7">return</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">page</span><span class="hl-1">) { </span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">pageIndex</span><span class="hl-1"> = </span><span class="hl-2">page</span><span class="hl-1">.</span><span class="hl-3">getAttribute</span><span class="hl-1">(</span><span class="hl-4">"data-index"</span><span class="hl-1">) * </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-6">pageLoc</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageLocation</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">), </span><span class="hl-6">scale</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getViewPort</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">).</span><span class="hl-2">scale</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">x</span><span class="hl-1"> = (</span><span class="hl-2">e</span><span class="hl-1">.</span><span class="hl-2">clientX</span><span class="hl-1"> - </span><span class="hl-2">pageLoc</span><span class="hl-1">.</span><span class="hl-2">x</span><span class="hl-1">) / </span><span class="hl-2">scale</span><span class="hl-1">, </span><span class="hl-6">y</span><span class="hl-1"> = (</span><span class="hl-2">e</span><span class="hl-1">.</span><span class="hl-2">clientY</span><span class="hl-1"> - </span><span class="hl-2">pageLoc</span><span class="hl-1">.</span><span class="hl-2">y</span><span class="hl-1">) / </span><span class="hl-2">scale</span><span class="hl-1">; </span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">rect</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">changeBoundsOrigin</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, [</span><span class="hl-2">x</span><span class="hl-1">, </span><span class="hl-2">y</span><span class="hl-1">, </span><span class="hl-2">x</span><span class="hl-1"> + </span><span class="hl-8">20</span><span class="hl-1">, </span><span class="hl-2">y</span><span class="hl-1"> + </span><span class="hl-8">20</span><span class="hl-1">], </span><span class="hl-4">"TopLeft"</span><span class="hl-1">, </span><span class="hl-4">"BottomLeft"</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotation</span><span class="hl-1">(</span><span class="hl-2">pageIndex</span><span class="hl-1">, { </span><span class="hl-2">annotationType:</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1"> , </span><span class="hl-2">contents:</span><span class="hl-1"> </span><span class="hl-4">"Text annotation content"</span><span class="hl-1">, </span><span class="hl-2">rect</span><span class="hl-1"> });</span><br/><span class="hl-1"> } </span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getPageLocation">getPageLocation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getPageRotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Page<wbr/>Rotation</span><a href="#getPageRotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getPageRotation.getPageRotation-1">get<wbr/>Page<wbr/>Rotation<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, includeViewRotation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getPageRotation.getPageRotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the page rotation value.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Get the first page rotation value:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">rotation</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageRotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>includeViewRotation: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
<div class="tsd-comment tsd-typography"><p>Include view rotation, default is true.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getPageRotation">getPageRotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getPageSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Page<wbr/>Size</span><a href="#getPageSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getPageSize.getPageSize-1">get<wbr/>Page<wbr/>Size<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, includeScale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><a href="#getPageSize.getPageSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the page size. By default, return size without scale,
pass true for the includeScale argument if you want to get the scaled value.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Get first page size:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageSize</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageSize</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Page index (Zero based).</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> includeScale: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. If true, the method will return scaled value.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getPageSize">getPageSize</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getPageTabs" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Page<wbr/>Tabs</span><a href="#getPageTabs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getPageTabs.getPageTabs-1">get<wbr/>Page<wbr/>Tabs<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"R"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"S"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"C"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"A"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"W"</span><a href="#getPageTabs.getPageTabs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get page annotations tabs order.
A name specifying the tab order that shall be used for annotations on the page.
Possible values are:
R - Row order.
C - Column order.
S - Structure order (not supported by DsPdfViewer).
A - Annotations order. This order refers to the order of annotation in the annotations collection.
W - Widgets order . This order uses the same ordering as "Annotations" order, but two passes are made,
the first only picking the widget annotations and the second picking all other annotations.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"R"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"S"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"C"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"A"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"W"</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getPageTabs">getPageTabs</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getPanelState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Panel<wbr/>State</span><a href="#getPanelState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getPanelState.getPanelState-1">get<wbr/>Panel<wbr/>State<span class="tsd-signature-symbol">(</span>panelKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PanelSettings</span><a href="#getPanelState.getPanelState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the current panel state.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>panelKey: <span class="tsd-signature-type">PanelHandle</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PanelSettings</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getPanelState">getPanelState</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getSelectedText" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Selected<wbr/>Text</span><a href="#getSelectedText" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getSelectedText.getSelectedText-1">get<wbr/>Selected<wbr/>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getSelectedText.getSelectedText-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the contents of the text selection.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"Text selected by the user: "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getSelectedText</span><span class="hl-1">());</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getSelectedText">getSelectedText</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getSharedDocuments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Shared<wbr/>Documents</span><a href="#getSharedDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getSharedDocuments.getSharedDocuments-1">get<wbr/>Shared<wbr/>Documents<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/SharedDocumentInfo.html" class="tsd-signature-type" data-tsd-kind="Type alias">SharedDocumentInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getSharedDocuments.getSharedDocuments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns a list of shared documents available to the current user.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">sharedDocuments</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getSharedDocuments</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/SharedDocumentInfo.html" class="tsd-signature-type" data-tsd-kind="Type alias">SharedDocumentInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getSharedDocuments">getSharedDocuments</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getSignatureInfo" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Signature<wbr/>Info</span><a href="#getSignatureInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getSignatureInfo.getSignatureInfo-1">get<wbr/>Signature<wbr/>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/SignatureInformation.html" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureInformation</a><span class="tsd-signature-symbol">></span><a href="#getSignatureInfo.getSignatureInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get information about signature used in document.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Example: check if the current document is signed and show information about signature:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-2">DsPdfViewer</span><span class="hl-1">.</span><span class="hl-3">findControl</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">signatureInfo</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getSignatureInfo</span><span class="hl-1">();</span><br/><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">signatureInfo</span><span class="hl-1">.</span><span class="hl-2">signed</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">signatureValue</span><span class="hl-1"> = </span><span class="hl-2">signatureInfo</span><span class="hl-1">.</span><span class="hl-2">signedByFields</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-2">signatureValue</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">signerName</span><span class="hl-1"> = </span><span class="hl-2">signatureValue</span><span class="hl-1">.</span><span class="hl-2">name</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">location</span><span class="hl-1"> = </span><span class="hl-2">signatureValue</span><span class="hl-1">.</span><span class="hl-2">location</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">signDate</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">pdfStringToDate</span><span class="hl-1">(</span><span class="hl-2">signatureValue</span><span class="hl-1">.</span><span class="hl-2">modificationDate</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document was signed using digital signature. Signed by: "</span><span class="hl-1"> + </span><span class="hl-2">signerName</span><span class="hl-1"> + </span><span class="hl-4">", location: "</span><span class="hl-1"> + </span><span class="hl-2">location</span><span class="hl-1"> + </span><span class="hl-4">", sign date: "</span><span class="hl-1"> + </span><span class="hl-2">signDate</span><span class="hl-1">.</span><span class="hl-3">toString</span><span class="hl-1">());</span><br/><span class="hl-1">} </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document is not signed."</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/SignatureInformation.html" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureInformation</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getSignatureInfo">getSignatureInfo</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getViewPort" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>View<wbr/>Port</span><a href="#getViewPort" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="getViewPort.getViewPort-1">get<wbr/>View<wbr/>Port<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/PageViewport.html" class="tsd-signature-type" data-tsd-kind="Type alias">PageViewport</a><a href="#getViewPort.getViewPort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns PDF page view port information.</p>
<h3>Returns</h3><p>Object containing following fields:
{
viewBox: // Original page bounds: [x1, y1, x2, y2].
// If you want to know original page's width/height, you can get it using viewBox values:
// var pageWidth = viewBox[2] - viewBox[0];
// var pageHeight = viewBox[3] - viewBox[1];
width: // Current width of the page in user space (scale and rotation values are applied),
height: // Current height of the page in user space (scale and rotation values are applied)
scale: // Active scale value
rotation: // Active rotation value
}</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Get the viewport object for the first page:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewPort</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getViewPort</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Page index (Zero based).</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/PageViewport.html" class="tsd-signature-type" data-tsd-kind="Type alias">PageViewport</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#getViewPort">getViewPort</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goBack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>Back</span><a href="#goBack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goBack.goBack-1">go<wbr/>Back<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goBack.goBack-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Move back in the document history.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goBack">goBack</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goForward" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>Forward</span><a href="#goForward" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goForward.goForward-1">go<wbr/>Forward<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goForward.goForward-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Move forward in the document history.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goForward">goForward</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goToFirstPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>To<wbr/>First<wbr/>Page</span><a href="#goToFirstPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goToFirstPage.goToFirstPage-1">go<wbr/>To<wbr/>First<wbr/>Page<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goToFirstPage.goToFirstPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Go to the first page.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">goToFirstPage</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goToFirstPage">goToFirstPage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goToLastPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>To<wbr/>Last<wbr/>Page</span><a href="#goToLastPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goToLastPage.goToLastPage-1">go<wbr/>To<wbr/>Last<wbr/>Page<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goToLastPage.goToLastPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Go to the last page.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">goToLastPage</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goToLastPage">goToLastPage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goToNextPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>To<wbr/>Next<wbr/>Page</span><a href="#goToNextPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goToNextPage.goToNextPage-1">go<wbr/>To<wbr/>Next<wbr/>Page<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goToNextPage.goToNextPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Go to the next page.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">goToNextPage</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goToNextPage">goToNextPage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goToPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>To<wbr/>Page</span><a href="#goToPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goToPage.goToPage-1">go<wbr/>To<wbr/>Page<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goToPage.goToPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Go to the page with the specific page index.</p>
<h3>Since</h3><p>2.3.1</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Go to the first page:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">goToPage</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goToPage">goToPage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goToPageNumber" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>To<wbr/>Page<wbr/>Number</span><a href="#goToPageNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goToPageNumber.goToPageNumber-1">go<wbr/>To<wbr/>Page<wbr/>Number<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goToPageNumber.goToPageNumber-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Go to the page with the specific page number (numbering starts at 1).</p>
<h3>Deprecated</h3><p>Method goToPageNumber deprecated since version 2.3.1, use goToPage method or pageIndex property instead.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Go to the second page:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">goToPageNumber</span><span class="hl-1">(</span><span class="hl-8">2</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageNumber: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goToPageNumber">goToPageNumber</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="goToPrevPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>go<wbr/>To<wbr/>Prev<wbr/>Page</span><a href="#goToPrevPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="goToPrevPage.goToPrevPage-1">go<wbr/>To<wbr/>Prev<wbr/>Page<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#goToPrevPage.goToPrevPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Go to the previous page.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">goToPrevPage</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#goToPrevPage">goToPrevPage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="hideSecondToolbar" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>hide<wbr/>Second<wbr/>Toolbar</span><a href="#hideSecondToolbar" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="hideSecondToolbar.hideSecondToolbar-1">hide<wbr/>Second<wbr/>Toolbar<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hideSecondToolbar.hideSecondToolbar-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Hide second toolbar.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">hideSecondToolbar</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#hideSecondToolbar">hideSecondToolbar</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="highlight" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>highlight</span><a href="#highlight" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="highlight.highlight-1">highlight<span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#highlight.highlight-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Navigates to a page containing the result and highlights found text.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>result: <span class="tsd-signature-type">SearchResult</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#highlight">highlight</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="highlightTextSegment" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>highlight<wbr/>Text<wbr/>Segment</span><a href="#highlightTextSegment" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="highlightTextSegment.highlightTextSegment-1">highlight<wbr/>Text<wbr/>Segment<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, startCharIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, endCharIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, args<span class="tsd-signature-symbol">??: </span><span class="tsd-signature-type">HighlightArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#highlightTextSegment.highlightTextSegment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Highlights a portion of text on a specified page.</p>
<p>This method creates a highlight for a segment of text on a page, with customizable properties. Optionally, it can clear previous highlights before adding the new one and skip the immediate repainting of the text layer.</p>
<h3>Returns</h3><p>A promise that resolves once the highlight has been added and optionally the text layer has been repainted.</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Add a highlight for a text segment from index 10 to 20 on page 0, with custom color and border, and clear existing highlights:</span><br/><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">highlightTextSegment</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">20</span><span class="hl-1">, { </span><span class="hl-2">color:</span><span class="hl-1"> </span><span class="hl-4">'rgba(255, 255, 0, 0.5)'</span><span class="hl-1">, </span><span class="hl-2">borderColor:</span><span class="hl-1"> </span><span class="hl-4">'rgba(255, 0, 0, 0.75)'</span><span class="hl-1">, </span><span class="hl-2">borderWidth:</span><span class="hl-1"> </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-2">clearPrevious:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span>
</code></pre>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Add a highlight and skip the immediate repaint of the text layer:</span><br/><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">highlightTextSegment</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">20</span><span class="hl-1">, { </span><span class="hl-2">color:</span><span class="hl-1"> </span><span class="hl-4">'#00FF00'</span><span class="hl-1">, </span><span class="hl-2">skipPaint:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span><br/><span class="hl-5">// Repaint the text layer manually:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">repaintTextLayer</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The index of the page where the text segment is located (0-based).</p>
</div></li>
<li>
<h5>startCharIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The starting character index (0-based) of the text segment to highlight.</p>
</div></li>
<li>
<h5>endCharIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The ending character index (0-based) of the text segment to highlight.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-type">HighlightArgs</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional parameters to customize the appearance and behavior of the highlight.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#highlightTextSegment">highlightTextSegment</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="invalidate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>invalidate</span><a href="#invalidate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="invalidate.invalidate-1">invalidate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#invalidate.invalidate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Ensures that all visual child elements of the viewer are properly updated for layout.
Call this method to update the size of the inner content when the viewer is dynamically resized.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">eventBus</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">"viewersizechanged"</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">// Make viewer height equal to content height of inner pages, including the margins:</span><br/><span class="hl-1"> </span><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-3">querySelector</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">).</span><span class="hl-2">style</span><span class="hl-1">.</span><span class="hl-2">height</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1"> * </span><span class="hl-8">50</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1"> * </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageSize</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-0">true</span><span class="hl-1">).</span><span class="hl-2">height</span><span class="hl-1"> + </span><span class="hl-4">"px"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">// Invalidate layout:</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">invalidate</span><span class="hl-1">();</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#invalidate">invalidate</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isFontUrlRegistered" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Font<wbr/>Url<wbr/>Registered</span><a href="#isFontUrlRegistered" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="isFontUrlRegistered.isFontUrlRegistered-1">is<wbr/>Font<wbr/>Url<wbr/>Registered<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isFontUrlRegistered.isFontUrlRegistered-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Checks if a font with the given URL is registered.</p>
<h3>Returns</h3><ul>
<li>Returns true if a font with the given URL is registered, false otherwise.</li>
</ul>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>url: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography"><p>The URL of the font to check.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#isFontUrlRegistered">isFontUrlRegistered</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="layoutPanels" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>layout<wbr/>Panels</span><a href="#layoutPanels" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="layoutPanels.layoutPanels-1">layout<wbr/>Panels<span class="tsd-signature-symbol">(</span>layout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#layoutPanels.layoutPanels-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Orders and filters panel items. '*' indicates "the rest of panels". 'sep'/'separator' indicated menu separator.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>layout: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#layoutPanels">layoutPanels</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="load" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load</span><a href="#load" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="load.load-1">load<span class="tsd-signature-symbol">(</span>moniker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DocumentMoniker</span>, token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CancellationToken</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LoadResult</span><span class="tsd-signature-symbol">></span><a href="#load.load-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Loads the report (no UI), so caller has to process load result and report error if any.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>moniker: <span class="tsd-signature-type">DocumentMoniker</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> token: <span class="tsd-signature-type">CancellationToken</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LoadResult</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#load">load</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="loadAndScrollPageIntoView" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load<wbr/>And<wbr/>Scroll<wbr/>Page<wbr/>Into<wbr/>View</span><a href="#loadAndScrollPageIntoView" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="loadAndScrollPageIntoView.loadAndScrollPageIntoView-1">load<wbr/>And<wbr/>Scroll<wbr/>Page<wbr/>Into<wbr/>View<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, destArray<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, scrollIntoViewOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../types/ScrollPageIntoViewOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ScrollPageIntoViewOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#loadAndScrollPageIntoView.loadAndScrollPageIntoView-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The method loads the page at the index specified by the pageIndex parameter, and scrolls the page into the view.</p>
<h3>Returns</h3><p>Returns the boolean promise that resolves when the page is fully loaded (including text and annotation layers) and scrolled.
A promise is resolved with false value when the page does not exist or an error occurs,
otherwise the promise is resolved with true value.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Load and display the first page:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">loadAndScrollPageIntoView</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Destination page index.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> destArray: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>Array with destination information.
destArray[0] // not used, can be null, pdf page reference (for internal use only).
destArray[1] // contains destination view fit type name:
{ name: 'XYZ' } - Destination specified as top-left corner point and a zoom factor (the lower-left corner of the page is the origin of the coordinate system (0, 0)).
{ name: 'Fit' } - Fits the page into the window
{ name: 'FitH' } - Fits the widths of the page into the window
{ name: 'FitV' } - Fits the height of the page into a window.
{ name: 'FitR' } - Fits the rectangle specified by its top-left and bottom-right corner points into the window.
{ name: 'FitB' } - Fits the rectangle containing all visible elements on the page into the window.
{ name: 'FitBH' } - Fits the width of the bounding box into the window.
{ name: 'FitBV' } - Fits the height of the bounding box into the window.
destArray[2] // x position offset
destArray[3] // y position offset (note, the lower-left corner of the page is the origin of the coordinate system (0, 0))
destArray[4] // can be null, contains bounding box width when view name is FitR,
contains scale when view name is XYZ,
destArray[5] // can be null, contains bounding box height when view name is FitR</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> scrollIntoViewOptions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../types/ScrollPageIntoViewOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ScrollPageIntoViewOptions</a></h5>
<div class="tsd-comment tsd-typography"><p>Optional scroll options. Used when the destArray parameter is not specified.
If true, the top of the element will be aligned to the top of the visible area of the scrollable ancestor.
Corresponds to scrollIntoViewOptions: {block: "start", inline: "nearest"}. This is the default value.
If false, the bottom of the element will be aligned to the bottom of the visible area of the scrollable ancestor.
Corresponds to scrollIntoViewOptions: {block: "end", inline: "nearest"}.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#loadAndScrollPageIntoView">loadAndScrollPageIntoView</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="loadDocumentList" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load<wbr/>Document<wbr/>List</span><a href="#loadDocumentList" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="loadDocumentList.loadDocumentList-1">load<wbr/>Document<wbr/>List<span class="tsd-signature-symbol">(</span>documentListUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/DocumentListItem.html" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentListItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#loadDocumentList.loadDocumentList-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Load an updated document list into document list panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">loadDocumentList</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Load document list using DATA URI:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">loadDocumentList</span><span class="hl-1">(</span><span class="hl-4">'data:,[{"path": "doc1.pdf"}, {"path": "doc2.pdf", "name": "doc 2", "title": "title 2"}]'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> documentListUrl: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/DocumentListItem.html" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentListItem</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. Document list service URL or array with the document list items.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#loadDocumentList">loadDocumentList</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="loadSharedDocuments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load<wbr/>Shared<wbr/>Documents</span><a href="#loadSharedDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="loadSharedDocuments.loadSharedDocuments-1">load<wbr/>Shared<wbr/>Documents<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#loadSharedDocuments.loadSharedDocuments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Loads the updated list of shared documents into the shared documents panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">loadSharedDocuments</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#loadSharedDocuments">loadSharedDocuments</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="lockAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lock<wbr/>Annotation</span><a href="#lockAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="lockAnnotation.lockAnnotation-1">lock<wbr/>Annotation<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">></span><a href="#lockAnnotation.lockAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Lock annotation for editing.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5>
<div class="tsd-comment tsd-typography"><p>annotation id</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#lockAnnotation">lockAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="markAnnotationLayerDirty" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>mark<wbr/>Annotation<wbr/>Layer<wbr/>Dirty</span><a href="#markAnnotationLayerDirty" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="markAnnotationLayerDirty.markAnnotationLayerDirty-1">mark<wbr/>Annotation<wbr/>Layer<wbr/>Dirty<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#markAnnotationLayerDirty.markAnnotationLayerDirty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Marks the annotation layer as dirty for specific page index or indices.
This method triggers the need for re-rendering the annotation layer in the page view
due to changes in annotation data for the specified page index or indices.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Example: Mark annotation layers for the first and third pages as dirty:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">markAnnotationLayerDirty</span><span class="hl-1">([</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">2</span><span class="hl-1">]);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>The index or indices of the page(s) for which the annotation layer is marked as dirty.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#markAnnotationLayerDirty">markAnnotationLayerDirty</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="newDocument" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>new<wbr/>Document</span><a href="#newDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="newDocument.newDocument-1">new<wbr/>Document<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>confirm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">LoadResult</span><span class="tsd-signature-symbol">></span><a href="#newDocument.newDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Creates and opens a new blank document.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Create a new blank document, name the file "test.pdf",</span><br/><span class="hl-5">// display a confirmation dialog if the active document has been modified.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">newDocument</span><span class="hl-1">({ </span><span class="hl-2">fileName:</span><span class="hl-1"> </span><span class="hl-4">"test.pdf"</span><span class="hl-1">, </span><span class="hl-2">confirm:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> params: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>confirm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>Parameters object:
fileName - name of the file for a new document,
confirm - show confirmation dialog if there are changes in the document.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">LoadResult</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#newDocument">newDocument</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="newPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>new<wbr/>Page</span><a href="#newPage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="newPage.newPage-1">new<wbr/>Page<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#newPage.newPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Adds a blank page to the document.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Create a new blank page and insert it in the second position.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">newPage</span><span class="hl-1">({</span><span class="hl-2">pageIndex:</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> params: <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>parameters object:
width - page width in points,
height - page height in points,
pageIndex - target page index.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> page<wbr/>Index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#newPage">newPage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="open" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>open</span><a href="#open" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="open.open-1">open<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, openParameters<span class="tsd-signature-symbol">?: </span><a href="../types/OpenParameters.html" class="tsd-signature-type" data-tsd-kind="Type alias">OpenParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LoadResult</span><span class="tsd-signature-symbol">></span><a href="#open.open-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Open PDF document.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">"Documents/HelloWorld.pdf"</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Specify Basic Access authentication headers:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">"http://localhost:5005/api/pdf-viewer/GetPdf?file=HelloWorld.pdf"</span><span class="hl-1">, { </span><br/><span class="hl-1"> </span><span class="hl-2">headers:</span><span class="hl-1"> { </span><br/><span class="hl-1"> </span><span class="hl-4">"Authorization"</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">"Basic "</span><span class="hl-1"> + </span><span class="hl-3">btoa</span><span class="hl-1">(</span><span class="hl-3">unescape</span><span class="hl-1">(</span><span class="hl-3">encodeURIComponent</span><span class="hl-1">(</span><span class="hl-4">"USERNAME:PASSWORD"</span><span class="hl-1">))),</span><br/><span class="hl-1"> </span><span class="hl-4">"CustomHeader"</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">"Custom header value"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> file: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography"><p>URL to PDF document(string) or binary data(Typed array - Uint8Array).</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> openParameters: <a href="../types/OpenParameters.html" class="tsd-signature-type" data-tsd-kind="Type alias">OpenParameters</a></h5>
<div class="tsd-comment tsd-typography"><p>Loading parameters object.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LoadResult</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#open">open</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="openLocalFile" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>open<wbr/>Local<wbr/>File</span><a href="#openLocalFile" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="openLocalFile.openLocalFile-1">open<wbr/>Local<wbr/>File<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#openLocalFile.openLocalFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Show the file open dialog where the user can select the PDF file.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">openLocalFile</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#openLocalFile">openLocalFile</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="openPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>open<wbr/>Panel</span><a href="#openPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="openPanel.openPanel-1">open<wbr/>Panel<span class="tsd-signature-symbol">(</span>panelHandleOrId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PanelHandle</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#openPanel.openPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Opens the side panel.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">layersPanelHandle</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addLayersPanel</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">"house-plan.pdf"</span><span class="hl-1">).</span><span class="hl-3">then</span><span class="hl-1">(()</span><span class="hl-0">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">openPanel</span><span class="hl-1">(</span><span class="hl-2">layersPanelHandle</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>panelHandleOrId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PanelHandle</span></h5>
<div class="tsd-comment tsd-typography"><p>Panel handle or panel id to open.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#openPanel">openPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="openSharedDocument" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>open<wbr/>Shared<wbr/>Document</span><a href="#openSharedDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="openSharedDocument.openSharedDocument-1">open<wbr/>Shared<wbr/>Document<span class="tsd-signature-symbol">(</span>sharedDocumentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpenDocumentInfo</span><span class="tsd-signature-symbol">></span><a href="#openSharedDocument.openSharedDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Open shared document by it's id.</p>
<h3>Example</h3><p>Open shared document using document index:</p>
<pre><code class="language-javascript"><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">openSharedDocByIndex</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">, </span><span class="hl-2">sharedDocIndex</span><span class="hl-1">) { </span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">sharedDocuments</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getSharedDocuments</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">openSharedDocument</span><span class="hl-1">(</span><span class="hl-2">sharedDocuments</span><span class="hl-1">[</span><span class="hl-2">sharedDocIndex</span><span class="hl-1">].</span><span class="hl-2">documentId</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-5">// Open first shared document:</span><br/><span class="hl-3">openSharedDocByIndex</span><span class="hl-1">(</span><span class="hl-2">DsPdfViewer</span><span class="hl-1">.</span><span class="hl-3">findControl</span><span class="hl-1">(</span><span class="hl-4">"#viewer"</span><span class="hl-1">), </span><span class="hl-8">0</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><p>Open shared document using document’s file name.
Note, a document with the same name can be shared multiple times.
In the example below, we open the first found document with the given fileName.</p>
<pre><code class="language-javascript"><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">openSharedDocByName</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">, </span><span class="hl-2">fileName</span><span class="hl-1">) { </span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">sharedDocuments</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getSharedDocuments</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">index</span><span class="hl-1"> = </span><span class="hl-2">sharedDocuments</span><span class="hl-1">.</span><span class="hl-3">findIndex</span><span class="hl-1">(</span><span class="hl-2">d</span><span class="hl-0">=></span><span class="hl-2">d</span><span class="hl-1">.</span><span class="hl-2">fileName</span><span class="hl-1"> === </span><span class="hl-2">fileName</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">index</span><span class="hl-1"> !== -</span><span class="hl-8">1</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">openSharedDocument</span><span class="hl-1">(</span><span class="hl-2">sharedDocuments</span><span class="hl-1">[</span><span class="hl-2">index</span><span class="hl-1">].</span><span class="hl-2">documentId</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-5">// Open the first available shared document named "financial-report.pdf":</span><br/><span class="hl-3">openSharedDocByName</span><span class="hl-1">(</span><span class="hl-2">DsPdfViewer</span><span class="hl-1">.</span><span class="hl-3">findControl</span><span class="hl-1">(</span><span class="hl-4">"#viewer"</span><span class="hl-1">), </span><span class="hl-4">"financial-report.pdf"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>sharedDocumentId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>unique shared document identifier.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpenDocumentInfo</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#openSharedDocument">openSharedDocument</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="openSharedDocumentByIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Index</span><a href="#openSharedDocumentByIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="openSharedDocumentByIndex.openSharedDocumentByIndex-1">open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Index<span class="tsd-signature-symbol">(</span>sharedDocIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpenDocumentInfo</span><span class="tsd-signature-symbol">></span><a href="#openSharedDocumentByIndex.openSharedDocumentByIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Open shared document using document index.</p>
<h3>Example</h3><p>Open second shared document:</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">openSharedDocumentByIndex</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>sharedDocIndex: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpenDocumentInfo</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#openSharedDocumentByIndex">openSharedDocumentByIndex</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="openSharedDocumentByName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Name</span><a href="#openSharedDocumentByName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="openSharedDocumentByName.openSharedDocumentByName-1">open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Name<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpenDocumentInfo</span><span class="tsd-signature-symbol">></span><a href="#openSharedDocumentByName.openSharedDocumentByName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Open shared document using document’s file name.
Note, a document with the same name can be shared multiple times.
The openSharedDocumentByName opens the first found document with the given fileName.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Open the first available shared document named "sample.pdf":</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">openSharedDocumentByName</span><span class="hl-1">(</span><span class="hl-4">"sample.pdf"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>fileName: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpenDocumentInfo</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#openSharedDocumentByName">openSharedDocumentByName</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="pdfStringToDate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pdf<wbr/>String<wbr/>To<wbr/>Date</span><a href="#pdfStringToDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="pdfStringToDate.pdfStringToDate-1">pdf<wbr/>String<wbr/>To<wbr/>Date<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><a href="#pdfStringToDate.pdfStringToDate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Convert a PDF date string to a JavaScript 'Date' object.
The PDF date string format is described in section 7.9.4 of the official PDF 32000-1:2008 specification.</p>
<h3>Returns</h3></div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> input: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#pdfStringToDate">pdfStringToDate</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="print" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>print</span><a href="#print" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="print.print-1">print<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#print.print-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Opens the browser's print document dialog box.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">print</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#print">print</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="redoChanges" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>redo<wbr/>Changes</span><a href="#redoChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="redoChanges.redoChanges-1">redo<wbr/>Changes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#redoChanges.redoChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Redo document changes.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasRedoChanges</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">redoChanges</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#redoChanges">redoChanges</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="registerFallbackFont" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>register<wbr/>Fallback<wbr/>Font</span><a href="#registerFallbackFont" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="registerFallbackFont.registerFallbackFont-1">register<wbr/>Fallback<wbr/>Font<span class="tsd-signature-symbol">(</span>fontNameOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, args<span class="tsd-signature-symbol">?: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>clientOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>displayName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>format<span class="tsd-signature-symbol">?: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#registerFallbackFont.registerFallbackFont-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Registers a fallback font with the given font name and URL.
The fallback font will not be added to the UI for selection.
Use this method to register a font that SupportApi will utilize when searching for fallback fonts.
This method supports font collections in "ttc" format.
The complete list of supported font formats includes "ttf", "otf", "woff", and "ttc".</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a fallback font URL</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFallbackFont</span><span class="hl-1">(</span><span class="hl-4">'https://example.com/fonts/fallbackfont.woff'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a fallback font with name and URL</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFallbackFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont1'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont1.woff'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a fallback font with name, URL, and format</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFallbackFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont2'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont2.ttf'</span><span class="hl-1">, { </span><span class="hl-2">format:</span><span class="hl-1"> </span><span class="hl-4">'truetype'</span><span class="hl-1"> });</span>
</code></pre>
<h3>Throws</h3><p>Throws an error if the provided fallback font URL is already registered.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>fontNameOrUrl: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The name of the fallback font to register or the URL of the font file.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The URL of the fallback font file.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>clientOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>displayName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>format<span class="tsd-signature-symbol">?: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional parameters for font registration.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#registerFallbackFont">registerFallbackFont</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="registerFont" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>register<wbr/>Font</span><a href="#registerFont" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="registerFont.registerFont-1">register<wbr/>Font<span class="tsd-signature-symbol">(</span>fontNameOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, args<span class="tsd-signature-symbol">?: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>addToUI<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>clientOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>displayName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>format<span class="tsd-signature-symbol">?: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol">; </span>serverOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#registerFont.registerFont-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Registers a new @font-face style with the given font name and URL.
The registered font will appear in the list of available fonts in the UI property grid
unless the addToUI parameter is set to false.
When the document is saved, the registered font will be uploaded to the SupportApi service
unless the clientOnly parameter is set to true.
If the serverOnly parameter is set to true, the font will not be registered on the client but will be sent to the SupportApi server.
Supported font formats include "ttf", "otf", and "woff". Please note that "woff2" is not supported by the Wasm version of the SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a font with name and URL</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont3'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont3.woff'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a font with name, URL, and format</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont4'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont4.ttf'</span><span class="hl-1">, </span><span class="hl-4">'ttf'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a font without adding it to the UI for selection</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont5'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont5.ttf'</span><span class="hl-1">, { </span><span class="hl-2">format:</span><span class="hl-1"> </span><span class="hl-4">'ttf'</span><span class="hl-1">, </span><span class="hl-2">addToUI:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1"> });</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a client-only font without sending it to the SupportApi server</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont6'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont6.ttf'</span><span class="hl-1">, { </span><span class="hl-2">format:</span><span class="hl-1"> </span><span class="hl-4">'ttf'</span><span class="hl-1">, </span><span class="hl-2">clientOnly:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Registering a server-only font without registering it on the client</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">registerFont</span><span class="hl-1">(</span><span class="hl-4">'SampleFont7'</span><span class="hl-1">, </span><span class="hl-4">'https://example.com/fonts/SampleFont7.ttf'</span><span class="hl-1">, { </span><span class="hl-2">format:</span><span class="hl-1"> </span><span class="hl-4">'ttf'</span><span class="hl-1">, </span><span class="hl-2">serverOnly:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span>
</code></pre>
<h3>Throws</h3><p>Throws an error if the provided font name is already registered.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>fontNameOrUrl: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The name of the font to register or the URL of the font file.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The URL of the font file.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>addToUI<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>clientOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>displayName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>format<span class="tsd-signature-symbol">?: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol">; </span>serverOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional parameters for font registration.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#registerFont">registerFont</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="removeAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>remove<wbr/>Annotation</span><a href="#removeAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="removeAnnotation.removeAnnotation-1">remove<wbr/>Annotation<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, annotationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#removeAnnotation.removeAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Remove annotation from document.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Remove annotation with id '2R' located on the first page:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">removeAnnotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-4">'2R'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>annotationId: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-symbol">{ </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> skip<wbr/>Page<wbr/>Refresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#removeAnnotation">removeAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="removeViewAreaStyle" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>remove<wbr/>View<wbr/>Area<wbr/>Style</span><a href="#removeViewAreaStyle" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="removeViewAreaStyle.removeViewAreaStyle-1">remove<wbr/>View<wbr/>Area<wbr/>Style<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#removeViewAreaStyle.removeViewAreaStyle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Removes a css style from the view area by its id.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">id</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addViewAreaStyle</span><span class="hl-1">(</span><span class="hl-4">".gc-text-content { font-size: 20px !important; }"</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">removeViewAreaStyle</span><span class="hl-1">(</span><span class="hl-2">id</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>style element identifier.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#removeViewAreaStyle">removeViewAreaStyle</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="repaint" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>repaint</span><a href="#repaint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="repaint.repaint-1">repaint<span class="tsd-signature-symbol">(</span>indicesToRepaint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#repaint.repaint-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Repaint pages. This method also redraws the page annotations.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Redraw content and annotations for visible pages:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">repaint</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Redraw content and annotations for pages with indexes 0 and 3:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">repaint</span><span class="hl-1">([</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">]);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> indicesToRepaint: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>If specified, page indices to be redrawn, otherwise, this method redraws visible pages.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#repaint">repaint</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="repaintTextLayer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>repaint<wbr/>Text<wbr/>Layer</span><a href="#repaintTextLayer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="repaintTextLayer.repaintTextLayer-1">repaint<wbr/>Text<wbr/>Layer<span class="tsd-signature-symbol">(</span>indicesToRepaint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#repaintTextLayer.repaintTextLayer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Repaints the text layer for the visible pages if the text layer is available.
This primarily involves repainting text selection and highlighting elements.</p>
<h3>Remarks</h3><p>This method is useful when the text layer needs to be updated after changes to page content or visibility.
It is particularly beneficial for improving performance when you want to repaint only text selection and highlighting
elements without redrawing the entire PDF page and annotations.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Repaint the text layer for all visible pages:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">repaintTextLayer</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Repaint the text layer for pages with indices 0 and 3:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">repaintTextLayer</span><span class="hl-1">([</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">]);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> indicesToRepaint: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography"><p>If specified, an array of page indices for which the text layer should be repainted.
If not specified, the method repaints the text layer for all visible pages.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#repaintTextLayer">repaintTextLayer</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="resetDocument" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>reset<wbr/>Document</span><a href="#resetDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="resetDocument.resetDocument-1">reset<wbr/>Document<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#resetDocument.resetDocument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Resets report and cancel current session if any.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#resetDocument">resetDocument</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="resetForm" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>reset<wbr/>Form</span><a href="#resetForm" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="resetForm.resetForm-1">reset<wbr/>Form<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#resetForm.resetForm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Reset form values.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#resetForm">resetForm</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="resolvePageIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>resolve<wbr/>Page<wbr/>Index</span><a href="#resolvePageIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="resolvePageIndex.resolvePageIndex-1">resolve<wbr/>Page<wbr/>Index<span class="tsd-signature-symbol">(</span>pageRef<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#resolvePageIndex.resolvePageIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Resolve page index using PDF page reference.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">openAction</span><span class="hl-1"> = (</span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">viewerPreferences</span><span class="hl-1">).</span><span class="hl-2">openAction</span><span class="hl-1">;</span><br/><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">openAction</span><span class="hl-1"> && </span><span class="hl-2">openAction</span><span class="hl-1">.</span><span class="hl-2">dest</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">pageRef</span><span class="hl-1"> = </span><span class="hl-2">openAction</span><span class="hl-1">.</span><span class="hl-2">dest</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">targetPageIndex</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">resolvePageIndex</span><span class="hl-1">(</span><span class="hl-2">pageRef</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageRef: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#resolvePageIndex">resolvePageIndex</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="resolveRegisteredFonts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>resolve<wbr/>Registered<wbr/>Fonts</span><a href="#resolveRegisteredFonts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="resolveRegisteredFonts.resolveRegisteredFonts-1">resolve<wbr/>Registered<wbr/>Fonts<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#resolveRegisteredFonts.resolveRegisteredFonts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Resolves registered fonts by downloading their data and storing it.</p>
<p>This method iterates over the registered fonts, downloads the font data if it hasn't been resolved yet,
and stores the data in the local storage. It returns a list of keys for the resolved font data.</p>
<h3>Returns</h3><ul>
<li>A promise that resolves to an array of keys for the resolved font data.</li>
</ul>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#resolveRegisteredFonts">resolveRegisteredFonts</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="save" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>save</span><a href="#save" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="save.save-1">save<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, settings<span class="tsd-signature-symbol">?: </span><a href="../types/SaveSettings.html" class="tsd-signature-type" data-tsd-kind="Type alias">SaveSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#save.save-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Save the modified PDF document to the local disk.
Requires SupportApi.</p>
<h3>Example</h3><p>Specify destination file name</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">save</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> fileName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Destination file name.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> settings: <a href="../types/SaveSettings.html" class="tsd-signature-type" data-tsd-kind="Type alias">SaveSettings</a></h5>
<div class="tsd-comment tsd-typography"><p>Additional save settings.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#save">save</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="saveAsImages" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>save<wbr/>As<wbr/>Images</span><a href="#saveAsImages" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="saveAsImages.saveAsImages-1">save<wbr/>As<wbr/>Images<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, settings<span class="tsd-signature-symbol">?: </span><a href="../types/SaveSettings.html" class="tsd-signature-type" data-tsd-kind="Type alias">SaveSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#saveAsImages.saveAsImages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Saves the pages of the current PDF document as PNG images, zips the result images, and downloads the result zip archive.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Save the pages of the current PDF document as PNG images and specify destination zip file name:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">saveAsImages</span><span class="hl-1">(</span><span class="hl-4">'Test.zip'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Save the pages of the current PDF document as PNG images,</span><br/><span class="hl-5">// and specify destination view zoom factor:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">saveAsImages</span><span class="hl-1">(</span><span class="hl-4">"sample.pdf"</span><span class="hl-1">, { </span><span class="hl-2">zoomFactor:</span><span class="hl-1"> </span><span class="hl-8">1.5</span><span class="hl-1"> });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> fileName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>optional, destination zip archive file name.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> settings: <a href="../types/SaveSettings.html" class="tsd-signature-type" data-tsd-kind="Type alias">SaveSettings</a></h5>
<div class="tsd-comment tsd-typography"><p>Additional save settings.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#saveAsImages">saveAsImages</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="saveChanges" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>save<wbr/>Changes</span><a href="#saveChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="saveChanges.saveChanges-1">save<wbr/>Changes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#saveChanges.saveChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Upload local changes to server.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">saveChanges</span><span class="hl-1">().</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">result</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">result</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document saved on the server."</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"Cannot save the document on the server."</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#saveChanges">saveChanges</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="scrollAnnotationIntoView" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>scroll<wbr/>Annotation<wbr/>Into<wbr/>View</span><a href="#scrollAnnotationIntoView" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="scrollAnnotationIntoView.scrollAnnotationIntoView-1">scroll<wbr/>Annotation<wbr/>Into<wbr/>View<span class="tsd-signature-symbol">(</span>pageIndexOrId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, annotationOrScrollOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/ScrollPageIntoViewOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ScrollPageIntoViewOptions</a><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>, scrollOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ScrollBehavior</span><span class="tsd-signature-symbol"> | </span><a href="../types/ScrollPageIntoViewOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ScrollPageIntoViewOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#scrollAnnotationIntoView.scrollAnnotationIntoView-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Scroll annotation into view.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Scroll the annotation located on the second page into view.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">scrollAnnotationIntoView</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">annotation</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Scroll annotation into view by id.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">scrollAnnotationIntoView</span><span class="hl-1">(</span><span class="hl-4">"2R"</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Scroll annotation into view by id using smooth scroll behavior.</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">scrollAnnotationIntoView</span><span class="hl-1">(</span><span class="hl-4">"2R"</span><span class="hl-1">, { </span><span class="hl-2">behavior:</span><span class="hl-1"> </span><span class="hl-4">"smooth"</span><span class="hl-1"> });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndexOrId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> annotationOrScrollOptions: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/ScrollPageIntoViewOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ScrollPageIntoViewOptions</a><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> scrollOptions: <span class="tsd-signature-type">ScrollBehavior</span><span class="tsd-signature-symbol"> | </span><a href="../types/ScrollPageIntoViewOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ScrollPageIntoViewOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#scrollAnnotationIntoView">scrollAnnotationIntoView</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="scrollPageIntoView" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>scroll<wbr/>Page<wbr/>Into<wbr/>View</span><a href="#scrollPageIntoView" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="scrollPageIntoView.scrollPageIntoView-1">scroll<wbr/>Page<wbr/>Into<wbr/>View<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowNegativeOffset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>destArray<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>pageNumber<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#scrollPageIntoView.scrollPageIntoView-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Scroll page into view.</p>
<h3>Deprecated</h3><p>Method scrollPageIntoView deprecated since v2.3.1
use methods goToPage, scrollAnnotationIntoView instead.</p>
<h3>Example</h3><ul>
<li><pre><code class="language-javascript">
</code></pre>
</li>
<li>// Scroll to page 10.</li>
<li>viewer.scrollPageIntoView( { pageNumber: 10 } )</li>
<li><pre><code>
</code></pre>
</li>
<li></li>
</ul>
<h3>Example</h3><ul>
<li><pre><code class="language-javascript">
</code></pre>
</li>
<li>// Scroll the annotation bounds rectangle into view:</li>
<li>var rectangle = annotation.rect;</li>
<li>var pagePosX = rectangle[0];</li>
<li>var pagePosY = rectangle[1] + Math.abs(rectangle[3] - rectangle[1]);</li>
<li>viewer.scrollPageIntoView({ pageNumber: pageIndex + 1, destArray: [null, { name: "XYZ" }, pagePosX, pagePosY, viewer.zoomValue / 100.0] });</li>
<li><pre><code>
</code></pre>
</li>
</ul>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>params: <span class="tsd-signature-symbol">{ </span>allowNegativeOffset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>destArray<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>pageNumber<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>object. Scroll parameters:
pageNumber - number. Page number.
destArray - Array with destination information:
destArray[0] // not used, can be null, pdf page reference (for internal use only).
destArray[1] // contains destination view fit type name:
{ name: 'XYZ' } - Destination specified as top-left corner point and a zoom factor (the lower-left corner of the page is the origin of the coordinate system (0, 0)).
{ name: 'Fit' } - Fits the page into the window
{ name: 'FitH' } - Fits the widths of the page into the window
{ name: 'FitV' } - Fits the height of the page into a window.
{ name: 'FitR' } - Fits the rectangle specified by its top-left and bottom-right corner points into the window.
{ name: 'FitB' } - Fits the rectangle containing all visible elements on the page into the window.
{ name: 'FitBH' } - Fits the width of the bounding box into the window.
{ name: 'FitBV' } - Fits the height of the bounding box into the window.</p>
<ul>
<li>destArray[2] // x position offset</li>
<li>destArray[3] // y position offset (note, the lower-left corner of the page is the origin of the coordinate system (0, 0))</li>
<li>destArray[4] // can be null, contains bounding box width when view name is FitR,</li>
<li><pre><code><span class="hl-1"> </span><span class="hl-2">contains</span><span class="hl-1"> </span><span class="hl-2">scale</span><span class="hl-1"> </span><span class="hl-2">when</span><span class="hl-1"> </span><span class="hl-2">view</span><span class="hl-1"> </span><span class="hl-2">name</span><span class="hl-1"> </span><span class="hl-2">is</span><span class="hl-1"> </span><span class="hl-6">XYZ</span><span class="hl-1">,</span>
</code></pre>
</li>
<li>destArray[5] // can be null, contains bounding box height when view name is FitR</li>
<li></li>
</ul>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> allow<wbr/>Negative<wbr/>Offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> dest<wbr/>Array<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li>
<li class="tsd-parameter">
<h5>page<wbr/>Number<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#scrollPageIntoView">scrollPageIntoView</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="search" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>search</span><a href="#search" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="search.search-1">search<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchOptions</span>, resultFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, progressFn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>pageCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, cancel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CancellationToken</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchStatus</span><span class="tsd-signature-symbol">></span><a href="#search.search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Searches currently opened document for the text.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>__namedParameters: <span class="tsd-signature-type">SearchOptions</span></h5></li>
<li>
<h5>resultFn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchResult</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>result: <span class="tsd-signature-type">SearchResult</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> progressFn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>pageCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>pageCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>progress: <span class="tsd-signature-symbol">{ </span>pageCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>page<wbr/>Count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>page<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> cancel: <span class="tsd-signature-type">CancellationToken</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchStatus</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#search">search</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="selectAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>select<wbr/>Annotation</span><a href="#selectAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="selectAnnotation.selectAnnotation-1">select<wbr/>Annotation<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, annotation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#selectAnnotation.selectAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Select the annotation to edit.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Select an annotation with id 2R:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">selectAnnotation</span><span class="hl-1">(</span><span class="hl-4">"2R"</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Select an annotation with id 9R located on the last page:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">selectAnnotation</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1"> - </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-4">"9R"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Page index (zero based) or annotation id.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> annotation: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5>
<div class="tsd-comment tsd-typography"><p>Annotation id or annotation object itself.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#selectAnnotation">selectAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setActiveBottomPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Active<wbr/>Bottom<wbr/>Panel</span><a href="#setActiveBottomPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setActiveBottomPanel.setActiveBottomPanel-1">set<wbr/>Active<wbr/>Bottom<wbr/>Panel<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setActiveBottomPanel.setActiveBottomPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Updates activeBottomPanelId for to show/hide panel with setting.location = 'bottom' (id = null to hide panel)</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>id: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setActiveBottomPanel">setActiveBottomPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setActiveTopPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Active<wbr/>Top<wbr/>Panel</span><a href="#setActiveTopPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setActiveTopPanel.setActiveTopPanel-1">set<wbr/>Active<wbr/>Top<wbr/>Panel<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setActiveTopPanel.setActiveTopPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Updates activeTopPanelId for to show/hide panel with setting.location = 'top' (id = null to hide panel)</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>id: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setActiveTopPanel">setActiveTopPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setAnnotationBounds" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Annotation<wbr/>Bounds</span><a href="#setAnnotationBounds" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setAnnotationBounds.setAnnotationBounds-1">set<wbr/>Annotation<wbr/>Bounds<span class="tsd-signature-symbol">(</span>annotationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bounds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span>, origin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span>, select<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setAnnotationBounds.setAnnotationBounds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Use the setAnnotationBounds method to set the position and / or size of the annotation.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Set the location of the annotation to the top / left corner:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setAnnotationBounds</span><span class="hl-1">(</span><span class="hl-4">'1R'</span><span class="hl-1">, {</span><span class="hl-2">x:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-2">y:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">});</span><br/><span class="hl-5">// Set the location of the annotation to the bottom / left corner:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setAnnotationBounds</span><span class="hl-1">(</span><span class="hl-4">'1R'</span><span class="hl-1">, {</span><span class="hl-2">x:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-2">y:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">}, </span><span class="hl-4">'BottomLeft'</span><span class="hl-1">);</span><br/><span class="hl-5">// Set the annotation size to 40 x 40 points:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setAnnotationBounds</span><span class="hl-1">(</span><span class="hl-4">'1R'</span><span class="hl-1">, {</span><span class="hl-2">w:</span><span class="hl-1"> </span><span class="hl-8">40</span><span class="hl-1">, </span><span class="hl-2">h:</span><span class="hl-1"> </span><span class="hl-8">40</span><span class="hl-1">});</span><br/><span class="hl-5">// Set the annotation position to x=50, y=50 (origin top / left) and size to 40 x 40 points:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setAnnotationBounds</span><span class="hl-1">(</span><span class="hl-4">'1R'</span><span class="hl-1">, {</span><span class="hl-2">x:</span><span class="hl-1"> </span><span class="hl-8">50</span><span class="hl-1">, </span><span class="hl-2">y:</span><span class="hl-1"> </span><span class="hl-8">50</span><span class="hl-1">, </span><span class="hl-2">w:</span><span class="hl-1"> </span><span class="hl-8">40</span><span class="hl-1">, </span><span class="hl-2">h:</span><span class="hl-1"> </span><span class="hl-8">40</span><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>annotationId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>annotation object or annotation id.</p>
</div></li>
<li>
<h5>bounds: <span class="tsd-signature-symbol">{ </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>Destination bounds - x, y, width and height are optional.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></li>
<li>
<h5>origin: <span class="tsd-signature-type">"TopLeft"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"BottomLeft"</span><span class="tsd-signature-symbol"> = 'TopLeft'</span></h5>
<div class="tsd-comment tsd-typography"><p>Source coordinate system origin. Default is TopLeft</p>
</div></li>
<li>
<h5>select: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography"><p>Select annotation after editing. Default is false.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setAnnotationBounds">setAnnotationBounds</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setPageRotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Page<wbr/>Rotation</span><a href="#setPageRotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setPageRotation.setPageRotation-1">set<wbr/>Page<wbr/>Rotation<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rotation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, viewRotationIncluded<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#setPageRotation.setPageRotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set the absolute page rotation in degrees.
Valid values are 0, 90, 180, and 270 degrees.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Set the first page rotation to 180 degrees:</span><br/><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setPageRotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">180</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>rotation: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>viewRotationIncluded: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setPageRotation">setPageRotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setPageSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Page<wbr/>Size</span><a href="#setPageSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setPageSize.setPageSize-1">set<wbr/>Page<wbr/>Size<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#setPageSize.setPageSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set page size.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Set new page size for the first page:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setPageSize</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, { </span><span class="hl-2">width:</span><span class="hl-1"> </span><span class="hl-8">300</span><span class="hl-1">, </span><span class="hl-2">height:</span><span class="hl-1"> </span><span class="hl-8">500</span><span class="hl-1"> } );</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>size: <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setPageSize">setPageSize</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setPageTabs" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Page<wbr/>Tabs</span><a href="#setPageTabs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setPageTabs.setPageTabs-1">set<wbr/>Page<wbr/>Tabs<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, tabs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"R"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"S"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"C"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"A"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"W"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setPageTabs.setPageTabs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set page annotations tabs order.
A name specifying the tab order that shall be used for annotations on the page.
Possible values are:
R - Row order.
C - Column order.
S - Structure order (not supported by DsPdfViewer).
A - Annotations order. This order refers to the order of annotation in the annotations collection.
W - Widgets order . This order uses the same ordering as "Annotations" order, but two passes are made,
the first only picking the widget annotations and the second picking all other annotations.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>tabs: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"R"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"S"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"C"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"A"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"W"</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setPageTabs">setPageTabs</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setTheme" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Theme</span><a href="#setTheme" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="setTheme.setTheme-1">set<wbr/>Theme<span class="tsd-signature-symbol">(</span>theme<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTheme.setTheme-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set active viewer theme.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">setTheme</span><span class="hl-1">(</span><span class="hl-4">"themes/light-blue"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> theme: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>theme name, specified in themes option.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#setTheme">setTheme</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showAnnotationFocusOutline" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Annotation<wbr/>Focus<wbr/>Outline</span><a href="#showAnnotationFocusOutline" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showAnnotationFocusOutline.showAnnotationFocusOutline-1">show<wbr/>Annotation<wbr/>Focus<wbr/>Outline<span class="tsd-signature-symbol">(</span>annotationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, animationDelay<span class="tsd-signature-symbol">??: </span><span class="tsd-signature-type">number</span>, color<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showAnnotationFocusOutline.showAnnotationFocusOutline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Show animated highlight for a specific annotation and then hide it with animation.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>annotationId: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography"><p>The ID or annotation object for which to show the highlight.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> animationDelay: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2000</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. The delay (in milliseconds) before hiding the animation.
Minimum value is 1000 milliseconds (1 second).</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> color: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showAnnotationFocusOutline">showAnnotationFocusOutline</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showFormFiller" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Form<wbr/>Filler</span><a href="#showFormFiller" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showFormFiller.showFormFiller-1">show<wbr/>Form<wbr/>Filler<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showFormFiller.showFormFiller-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Displays 'Form filler' dialog.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasForm</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showFormFiller</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showFormFiller">showFormFiller</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showMessage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Message</span><a href="#showMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showMessage.showMessage-1">show<wbr/>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, details<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, severity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"warn"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"debug"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showMessage.showMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Shows the message for the user.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Show warning message</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showMessage</span><span class="hl-1">(</span><span class="hl-4">"Warning message text"</span><span class="hl-1">, </span><span class="hl-4">""</span><span class="hl-1">, </span><span class="hl-4">"warn"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>details: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5></li>
<li>
<h5>severity: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"warn"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"debug"</span><span class="tsd-signature-symbol"> = "info"</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showMessage">showMessage</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showPanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Panel</span><a href="#showPanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showPanel.showPanel-1">show<wbr/>Panel<span class="tsd-signature-symbol">(</span>panelKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span>, visible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showPanel.showPanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Updates the panel visibility.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>panelKey: <span class="tsd-signature-type">PanelHandle</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> visible: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showPanel">showPanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showPdfOrganizer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Pdf<wbr/>Organizer</span><a href="#showPdfOrganizer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showPdfOrganizer.showPdfOrganizer-1">show<wbr/>Pdf<wbr/>Organizer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PdfOrganizerDialog</span><a href="#showPdfOrganizer.showPdfOrganizer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Show PDF Organizer dialog.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showPdfOrganizer</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PdfOrganizerDialog</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showPdfOrganizer">showPdfOrganizer</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showReplaceText" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Replace<wbr/>Text</span><a href="#showReplaceText" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showReplaceText.showReplaceText-1">show<wbr/>Replace<wbr/>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReplaceTextDialog</span><a href="#showReplaceText.showReplaceText-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Show Replace Text dialog.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showReplaceText</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReplaceTextDialog</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showReplaceText">showReplaceText</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showSecondToolbar" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Second<wbr/>Toolbar</span><a href="#showSecondToolbar" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showSecondToolbar.showSecondToolbar-1">show<wbr/>Second<wbr/>Toolbar<span class="tsd-signature-symbol">(</span>toolbarKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#showSecondToolbar.showSecondToolbar-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Show a second toolbar with a key specified by the toolbarKey argument.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showSecondToolbar</span><span class="hl-1">(</span><span class="hl-4">"draw-tools"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>toolbarKey: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showSecondToolbar">showSecondToolbar</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="showSignTool" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show<wbr/>Sign<wbr/>Tool</span><a href="#showSignTool" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="showSignTool.showSignTool-1">show<wbr/>Sign<wbr/>Tool<span class="tsd-signature-symbol">(</span>preferredSettings<span class="tsd-signature-symbol">?: </span><a href="../types/SignToolSettings.html" class="tsd-signature-type" data-tsd-kind="Type alias">SignToolSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showSignTool.showSignTool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Displays the 'Add Signature' dialog.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showSignTool</span><span class="hl-1">();</span>
</code></pre>
<ul>
<li></li>
</ul>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> preferredSettings: <a href="../types/SignToolSettings.html" class="tsd-signature-type" data-tsd-kind="Type alias">SignToolSettings</a></h5>
<div class="tsd-comment tsd-typography"><p>Optional. These settings will take priority over signSettings option.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#showSignTool">showSignTool</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="submitForm" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>submit<wbr/>Form</span><a href="#submitForm" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="submitForm.submitForm-1">submit<wbr/>Form<span class="tsd-signature-symbol">(</span>submitUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SubmitFormOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#submitForm.submitForm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Executes "Submit A Form action" to send filled form data to a web server or email.
Form data is submitted as HTML form using HTML <a href="https://www.w3schools.com/jsref/met_form_submit.asp">submit</a> method.</p>
<h3>Example</h3><p>Submit form to a web server using absolute URL:</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">submitForm</span><span class="hl-1">(</span><span class="hl-4">"http://myhost.local/AcceptHtmlForm"</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><p>Submit form to a web server using relative URL:</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">submitForm</span><span class="hl-1">(</span><span class="hl-4">"/CustomFormHandler"</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><p>Submit form to an email address:</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">submitForm</span><span class="hl-1">(</span><span class="hl-4">"mailto:myform@example.com"</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>submitUrl: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Destination URI.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SubmitFormOptions</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional, submit form options.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#submitForm">submitForm</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="triggerEvent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>trigger<wbr/>Event</span><a href="#triggerEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="triggerEvent.triggerEvent-1">trigger<wbr/>Event<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventName</span>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EventArgs</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BeforeOpenEventArgs</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ThemeChangedEventArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerEvent.triggerEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Trigger event.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Listen CustomEvent:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getEvent</span><span class="hl-1">(</span><span class="hl-4">"CustomEvent"</span><span class="hl-1">).</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Trigger CustomEvent:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">triggerEvent</span><span class="hl-1">(</span><span class="hl-4">"CustomEvent"</span><span class="hl-1">, { </span><span class="hl-2">arg1:</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">arg2:</span><span class="hl-1"> </span><span class="hl-8">2</span><span class="hl-1">});</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>eventName: <span class="tsd-signature-type">EventName</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-type">EventArgs</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BeforeOpenEventArgs</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ThemeChangedEventArgs</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#triggerEvent">triggerEvent</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="undoChanges" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>undo<wbr/>Changes</span><a href="#undoChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="undoChanges.undoChanges-1">undo<wbr/>Changes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#undoChanges.undoChanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Undo document changes.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasUndoChanges</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">undoChanges</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#undoChanges">undoChanges</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="unlockAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unlock<wbr/>Annotation</span><a href="#unlockAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="unlockAnnotation.unlockAnnotation-1">unlock<wbr/>Annotation<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">></span><a href="#unlockAnnotation.unlockAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Unlock annotation for editing.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5>
<div class="tsd-comment tsd-typography"><p>annotation id</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#unlockAnnotation">unlockAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="unselectAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unselect<wbr/>Annotation</span><a href="#unselectAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="unselectAnnotation.unselectAnnotation-1">unselect<wbr/>Annotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#unselectAnnotation.unselectAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Reset annotation selection.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">unselectAnnotation</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#unselectAnnotation">unselectAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="updateAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update<wbr/>Annotation</span><a href="#updateAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="updateAnnotation.updateAnnotation-1">update<wbr/>Annotation<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>changedPageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prevPageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><a href="#updateAnnotation.updateAnnotation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Update annotation.
Requires SupportApi.</p>
<h3>Returns</h3><p>Promise, resolved by updated annotation object.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Update annotation on the first page (page index is 0):</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">updateAnnotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-2">annotation1</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>annotation: <a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5></li>
<li>
<h5>args: <span class="tsd-signature-symbol">{ </span>changedPageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prevPageIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> changed<wbr/>Page<wbr/>Index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> prev<wbr/>Page<wbr/>Index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> skip<wbr/>Page<wbr/>Refresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#updateAnnotation">updateAnnotation</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="updateAnnotations" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update<wbr/>Annotations</span><a href="#updateAnnotations" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="updateAnnotations.updateAnnotations-1">update<wbr/>Annotations<span class="tsd-signature-symbol">(</span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, annotations<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotations<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><a href="#updateAnnotations.updateAnnotations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Update multiple annotations at the same time.
Requires SupportApi.</p>
<h3>Returns</h3><p>Promise, resolved by updated annotation objects.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Update annotations on the second page (page index is 1):</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">annotationsToUpdate</span><span class="hl-1"> = [</span><span class="hl-2">annotation1</span><span class="hl-1">, </span><span class="hl-2">annotation2</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">updateAnnotations</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">annotationsToUpdate</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>pageIndex: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5>annotations: <a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol"> | </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-symbol">{ </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> skip<wbr/>Page<wbr/>Refresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotations<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#updateAnnotations">updateAnnotations</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="updateGroupFieldValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update<wbr/>Group<wbr/>Field<wbr/>Value</span><a href="#updateGroupFieldValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="updateGroupFieldValue.updateGroupFieldValue-1">update<wbr/>Group<wbr/>Field<wbr/>Value<span class="tsd-signature-symbol">(</span>fieldName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, newValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, args<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>propertyName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#updateGroupFieldValue.updateGroupFieldValue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Update radio buttons group given by parameter fieldName with new field value.</p>
<h3>Returns</h3><p>Promise resolved by boolean value, true - radio buttons updated, false - an error occurred.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">updateGroupFieldValue</span><span class="hl-1">(</span><span class="hl-4">"radiogroup1"</span><span class="hl-1">, </span><span class="hl-4">"3"</span><span class="hl-1">, { </span><span class="hl-2">skipPageRefresh:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> } );</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">updateGroupFieldValue</span><span class="hl-1">(</span><span class="hl-4">"radiogroup1"</span><span class="hl-1">, </span><span class="hl-4">"3"</span><span class="hl-1">, { </span><span class="hl-2">propertyName:</span><span class="hl-1"> </span><span class="hl-4">"alternativeText"</span><span class="hl-1">, </span><span class="hl-2">skipPageRefresh:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> } );</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>fieldName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Grouped radio buttons field name</p>
</div></li>
<li>
<h5>newValue: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>New fieldValue</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> args: <span class="tsd-signature-symbol">{ </span>propertyName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>skipPageRefresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography"><p>skipPageRefresh boolean - set to true if you don't need to update page display. Default is false.
propertyName string - property name to update. Default is "fieldValue".</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> property<wbr/>Name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> skip<wbr/>Page<wbr/>Refresh<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#updateGroupFieldValue">updateGroupFieldValue</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="updatePanel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update<wbr/>Panel</span><a href="#updatePanel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="updatePanel.updatePanel-1">update<wbr/>Panel<span class="tsd-signature-symbol">(</span>panelKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PanelHandle</span>, settings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PanelSettings</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#updatePanel.updatePanel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Updates panel settings such as visibility, label or "enabled" status.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>panelKey: <span class="tsd-signature-type">PanelHandle</span></h5></li>
<li>
<h5>settings: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PanelSettings</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#updatePanel">updatePanel</a></p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="validateForm" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>validate<wbr/>Form</span><a href="#validateForm" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="validateForm.validateForm-1">validate<wbr/>Form<span class="tsd-signature-symbol">(</span>validator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>fieldValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, field<span class="tsd-signature-symbol">: </span><a href="WidgetAnnotation.html" class="tsd-signature-type" data-tsd-kind="Class">WidgetAnnotation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span>, silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, ignoreValidationAttrs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><a href="#validateForm.validateForm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Use this method to validate an active form and get the validation result.</p>
<h3>Returns</h3><p>Returns true if validation was successful, false, or a string with a validation error message when validation is failed.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Validate all form fields, each field must have the value "YES" or "NO".</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">validateForm</span><span class="hl-1">((</span><span class="hl-2">fieldValue</span><span class="hl-1">, </span><span class="hl-2">field</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> { </span><span class="hl-7">return</span><span class="hl-1"> (</span><span class="hl-2">fieldValue</span><span class="hl-1"> === </span><span class="hl-4">"YES"</span><span class="hl-1"> || </span><span class="hl-2">fieldValue</span><span class="hl-1"> === </span><span class="hl-4">"NO"</span><span class="hl-1">) ? </span><span class="hl-0">true</span><span class="hl-1"> : </span><span class="hl-4">"Possible value is YES or NO."</span><span class="hl-1">; });</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> validator: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>fieldValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, field<span class="tsd-signature-symbol">: </span><a href="WidgetAnnotation.html" class="tsd-signature-type" data-tsd-kind="Class">WidgetAnnotation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. The validator function which will be called for each field in the form.
You can return a string value with message about validation error, this message will be shown in UI.
Return true or null for success result.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>fieldValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, field<span class="tsd-signature-symbol">: </span><a href="WidgetAnnotation.html" class="tsd-signature-type" data-tsd-kind="Class">WidgetAnnotation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>fieldValue: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
<li>
<h5>field: <a href="WidgetAnnotation.html" class="tsd-signature-type" data-tsd-kind="Class">WidgetAnnotation</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> silent: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. Pass true if you don't want to display any messages to the user, but just want to get the final validation result.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> ignoreValidationAttrs: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>Optional. Pass true to skip validation using field attributes such as required,
min, max, minLength, maxLength, email and pattern, these attributes will be ignored.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#validateForm">validateForm</a></p></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="i18n" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>i18n</span><a href="#i18n" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="i18n.i18n-1"><span class="tsd-signature-symbol">get</span> i18n<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">i18n</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets i18next instance which can be used to add viewer translations.
See <a href="https://www.i18next.com">https://www.i18next.com</a> for details about i18next framework.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">loadPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// You can load translations from any source (see en-pdf-viewer.json for an example):</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">myTranslations</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">"toolbar"</span><span class="hl-2">:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">"open-document"</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">"Open MY document"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">"pan"</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">"My Pan tool"</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> };</span><br/><span class="hl-1"> </span><span class="hl-5">// Initialize translations:</span><br/><span class="hl-1"> </span><span class="hl-2">DsPdfViewer</span><span class="hl-1">.</span><span class="hl-2">i18n</span><span class="hl-1">.</span><span class="hl-3">init</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">resources:</span><span class="hl-1"> { </span><span class="hl-2">myLang:</span><span class="hl-1"> { </span><span class="hl-2">viewer:</span><span class="hl-1"> </span><span class="hl-2">myTranslations</span><span class="hl-1"> } },</span><br/><span class="hl-1"> </span><span class="hl-2">defaultNS:</span><span class="hl-1"> </span><span class="hl-4">'viewer'</span><br/><span class="hl-1"> }).</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">t</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// New translations initialized and ready to go!</span><br/><span class="hl-1"> </span><span class="hl-5">// Now create PDF viewer:</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">, { </span><span class="hl-2">language:</span><span class="hl-1"> </span><span class="hl-4">'myLang'</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">//viewer.open("sample.pdf");</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">}</span><br/><span class="hl-3">loadPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">i18n</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.i18n</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="activatedEditorMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>activated<wbr/>Editor<wbr/>Mode</span><a href="#activatedEditorMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="activatedEditorMode.activatedEditorMode-1"><span class="tsd-signature-symbol">get</span> activatedEditorMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">""</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"SecondBar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FormEditor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"AnnotationEdtor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Any"</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Activated editor mode name.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">""</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"SecondBar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FormEditor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"AnnotationEdtor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Any"</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.activatedEditorMode</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="annotations" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>annotations</span><a href="#annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="annotations.annotations-1"><span class="tsd-signature-symbol">get</span> annotations<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotations<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets all document annotations.
*</p>
<h3>Example</h3><ul>
<li><pre><code class="language-javascript">
</code></pre>
</li>
<li>var viewer = new DsPdfViewer('#root');</li>
<li>viewer.addDefaultPanels();</li>
<li>viewer.onAfterOpen.register(function() {</li>
<li>viewer.annotations.then(function(data) {</li>
<li><pre><code><span class="hl-7">for</span><span class="hl-1">(</span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">; </span><span class="hl-2">i</span><span class="hl-1"> < </span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1">; </span><span class="hl-2">i</span><span class="hl-1">++){</span>
</code></pre>
</li>
<li><pre><code><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageAnnotationsData</span><span class="hl-1"> = </span><span class="hl-2">data</span><span class="hl-1">[</span><span class="hl-2">i</span><span class="hl-1">];</span>
</code></pre>
</li>
<li><pre><code><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-2">pageAnnotationsData</span><span class="hl-1">.</span><span class="hl-2">pageIndex</span><span class="hl-1">;</span>
</code></pre>
</li>
<li><pre><code><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">annotations</span><span class="hl-1"> = </span><span class="hl-2">pageAnnotationsData</span><span class="hl-1">.</span><span class="hl-2">annotations</span><span class="hl-1">;</span>
</code></pre>
</li>
<li><pre><code><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">"Page with index "</span><span class="hl-1"> + </span><span class="hl-2">pageIndex</span><span class="hl-1"> + </span><span class="hl-4">" contains "</span><span class="hl-1"> + </span><span class="hl-2">annotations</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1"> + </span><span class="hl-4">" annotation(s)"</span><span class="hl-1">);</span>
</code></pre>
</li>
<li><pre><code><span class="hl-1">}</span>
</code></pre>
</li>
<li>});</li>
<li>});</li>
<li>viewer.open('Test.pdf');</li>
<li><pre><code>
</code></pre>
</li>
</ul>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>annotations<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.annotations</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="backgroundColor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>background<wbr/>Color</span><a href="#backgroundColor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="backgroundColor.backgroundColor-1"><span class="tsd-signature-symbol">get</span> backgroundColor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets or sets viewer background color, default value = 'transparent'</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.backgroundColor</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="beforeUnloadConfirmation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>before<wbr/>Unload<wbr/>Confirmation</span><a href="#beforeUnloadConfirmation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="beforeUnloadConfirmation.beforeUnloadConfirmation-1"><span class="tsd-signature-symbol">get</span> beforeUnloadConfirmation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Ask the user if he want to leave the page when document is modified.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">supportApi:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1"> } );</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotationEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addFormEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">beforeUnloadConfirmation</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.beforeUnloadConfirmation</p></aside></li>
<li class="tsd-signature" id="beforeUnloadConfirmation.beforeUnloadConfirmation-2"><span class="tsd-signature-symbol">set</span> beforeUnloadConfirmation<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Ask the user if he want to leave the page when document is modified.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">supportApi:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1"> } );</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotationEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addFormEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">beforeUnloadConfirmation</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>enable: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.beforeUnloadConfirmation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="canEditDocument" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>can<wbr/>Edit<wbr/>Document</span><a href="#canEditDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="canEditDocument.canEditDocument-1"><span class="tsd-signature-symbol">get</span> canEditDocument<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates whether the open document can be edited using SupportApi.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">canEditDocument</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"Document editing features enabled."</span><span class="hl-1">);</span><br/><span class="hl-1">} </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"Document editing features disabled."</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.canEditDocument</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="currentUserName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>current<wbr/>User<wbr/>Name</span><a href="#currentUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="currentUserName.currentUserName-1"><span class="tsd-signature-symbol">get</span> currentUserName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Specifies the current user name.
The property is used by Annotation Editor as default value for 'author' field.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">currentUserName</span><span class="hl-1"> = </span><span class="hl-4">"John"</span><span class="hl-1">;</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The current user name is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">currentUserName</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.currentUserName</p></aside></li>
<li class="tsd-signature" id="currentUserName.currentUserName-2"><span class="tsd-signature-symbol">set</span> currentUserName<span class="tsd-signature-symbol">(</span>userName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Specifies the current user name.
The property is used by Annotation Editor as default value for 'author' field.
Note, current user name is saved in the browser's local storage and it will be used
on the next page reload if userName option is not set.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">currentUserName</span><span class="hl-1"> = </span><span class="hl-4">"John"</span><span class="hl-1">;</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The current user name is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">currentUserName</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>userName: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.currentUserName</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="dataLoader" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>data<wbr/>Loader</span><a href="#dataLoader" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="dataLoader.dataLoader-1"><span class="tsd-signature-symbol">get</span> dataLoader<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GcPdfViewerDataLoader</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>PDF document meta data loader. Used by some sidebar panels.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GcPdfViewerDataLoader</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.dataLoader</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="document" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>document</span><a href="#document" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="document.document-1"><span class="tsd-signature-symbol">get</span> document<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IDocumentView</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the current document</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IDocumentView</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.document</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="editMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>edit<wbr/>Mode</span><a href="#editMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="editMode.editMode-1"><span class="tsd-signature-symbol">get</span> editMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EditMode</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates the selected editing tool for the Annotation editor or Form editor.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Set the layout mode to "Annotation editor"</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">layoutMode</span><span class="hl-1"> = </span><span class="hl-8">1</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">// Set the edit mode to "Square".</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">editMode</span><span class="hl-1"> = </span><span class="hl-8">4</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EditMode</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.editMode</p></aside></li>
<li class="tsd-signature" id="editMode.editMode-2"><span class="tsd-signature-symbol">set</span> editMode<span class="tsd-signature-symbol">(</span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EditMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates the selected editing tool for the Annotation editor or Form editor.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Set the layout mode to "Annotation editor"</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">layoutMode</span><span class="hl-1"> = </span><span class="hl-8">1</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">// Set the edit mode to "Square".</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">editMode</span><span class="hl-1"> = </span><span class="hl-8">4</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>mode: <span class="tsd-signature-type">EditMode</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.editMode</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="errorHandler" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>error<wbr/>Handler</span><a href="#errorHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="errorHandler.errorHandler-1"><span class="tsd-signature-symbol">get</span> errorHandler<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ErrorHandler</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets or sets callback that is invoked when an error occurs in the process of displaying the report</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ErrorHandler</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.errorHandler</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="eventBus" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>event<wbr/>Bus</span><a href="#eventBus" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="eventBus.eventBus-1"><span class="tsd-signature-symbol">get</span> eventBus<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/IGCEventBus.html" class="tsd-signature-type" data-tsd-kind="Interface">IGCEventBus</a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Internal event bus. Available event names are: outlineloaded, attachmentsloaded, namedaction, pagemode, fileattachmentannotation, pagerendered,
pagecancelled, scalechange, pagesinit, pagesloaded, documentchanged, rotationchanging, updateviewarea, undostorechanged,
show-custom-layout, hide-custom-layout, annotationeditstarted, unselectannotation, annotation-bounds-change, pagechange,
mousemodechange, request-answer, textlayerready, textselectionchanged, viewersizechanged, articlebeadnavigate, error, open, pagelabels, documentload.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Example: listen annotation selected/unselected event.</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-2">DsPdfViewer</span><span class="hl-1">.</span><span class="hl-3">findControl</span><span class="hl-1">(</span><span class="hl-4">"#root"</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">eventBus</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">"annotationeditstarted"</span><span class="hl-1">, (</span><span class="hl-2">args</span><span class="hl-1">)</span><span class="hl-0">=></span><span class="hl-1"> { </span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">"Annotation selected, annotation id: "</span><span class="hl-1"> + </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">annotationId</span><span class="hl-1">); </span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">eventBus</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">"unselectannotation"</span><span class="hl-1">, (</span><span class="hl-2">args</span><span class="hl-1">)</span><span class="hl-0">=></span><span class="hl-1"> { </span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">"Annotation unselected, annotation id: "</span><span class="hl-1"> + </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">annotationId</span><span class="hl-1">); </span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/IGCEventBus.html" class="tsd-signature-type" data-tsd-kind="Interface">IGCEventBus</a></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.eventBus</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="fileData" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>file<wbr/>Data</span><a href="#fileData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="fileData.fileData-1"><span class="tsd-signature-symbol">get</span> fileData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the file data. Available when keepFileData option is set to true.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">keepFileData:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pdfFileData</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">fileData</span><span class="hl-1">;</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.fileData</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="fileName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>file<wbr/>Name</span><a href="#fileName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="fileName.fileName-1"><span class="tsd-signature-symbol">get</span> fileName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the file name that was used to open the document.
The file name is determined as follows:</p>
<ul>
<li>if a local file was opened using the "Open File" dialog, returns the local file name;</li>
<li>else, if a new file was created using the "newDocument" method, returns the argument passed to that method;</li>
<li>else, if options.friendlyFileName is not empty, returns its value;</li>
<li>else, returns the name generated from the URL passed to the "open" method.</li>
</ul>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document is opened, the fileName is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">fileName</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'MyDocuments/Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.fileName</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="fileSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>file<wbr/>Size</span><a href="#fileSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="fileSize.fileSize-1"><span class="tsd-signature-symbol">get</span> fileSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the PDF document file size in bytes.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">fileSizeBytes</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">fileSize</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.fileSize</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="fileUrl" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>file<wbr/>Url</span><a href="#fileUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="fileUrl.fileUrl-1"><span class="tsd-signature-symbol">get</span> fileUrl<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the URL that was used to open the document.
Returns an empty string when the document was opened from binary data.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document is opened, the fileUrl is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">fileUrl</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'MyDocuments/Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.fileUrl</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="fingerprint" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>fingerprint</span><a href="#fingerprint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="fingerprint.fingerprint-1"><span class="tsd-signature-symbol">get</span> fingerprint<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>An unique document identifier.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document opened, an unique document identifier is "</span><span class="hl-1">+ </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">fingerprint</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.fingerprint</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="gcPdfVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>gc<wbr/>Pdf<wbr/>Version</span><a href="#gcPdfVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="gcPdfVersion.gcPdfVersion-1"><span class="tsd-signature-symbol">get</span> gcPdfVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the GcPdf library version used by the SupportApi, if available.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.gcPdfVersion</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasChanges" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Changes</span><a href="#hasChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasChanges.hasChanges-1"><span class="tsd-signature-symbol">get</span> hasChanges<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates whether the document has been modified by the user.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasChanges</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document has been changed."</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasChanges</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasCopyData" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Copy<wbr/>Data</span><a href="#hasCopyData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasCopyData.hasCopyData-1"><span class="tsd-signature-symbol">get</span> hasCopyData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates whether the copy buffer contains any data.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasCopyData</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">execPasteAction</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasCopyData</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasDocument" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Document</span><a href="#hasDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasDocument.hasDocument-1"><span class="tsd-signature-symbol">get</span> hasDocument<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates whether the document is loaded into view.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(!</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasDocument</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">"sample.pdf"</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasDocument</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasForm" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Form</span><a href="#hasForm" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasForm.hasForm-1"><span class="tsd-signature-symbol">get</span> hasForm<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets a value indicating whether the active document has any form fields.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasForm</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">showFormFiller</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasForm</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasPersistentConnection" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Persistent<wbr/>Connection</span><a href="#hasPersistentConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasPersistentConnection.hasPersistentConnection-1"><span class="tsd-signature-symbol">get</span> hasPersistentConnection<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets a value indicating whether the viewer has a persistent connection to the server.</p>
<ul>
<li><pre><code class="language-javascript">
</code></pre>
</li>
<li>if(viewer.hasPersistentConnection) {</li>
<li>viewer.getSharedDocuments().then(function(result) {</li>
<li></li>
<li>});</li>
<li>}</li>
<li><pre><code>
</code></pre>
</li>
</ul>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasPersistentConnection</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasRedoChanges" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Redo<wbr/>Changes</span><a href="#hasRedoChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasRedoChanges.hasRedoChanges-1"><span class="tsd-signature-symbol">get</span> hasRedoChanges<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets a value indicating whether the pdf viewer can redo document changes.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasRedoChanges</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">redoChanges</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasRedoChanges</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasReplyTool" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Reply<wbr/>Tool</span><a href="#hasReplyTool" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasReplyTool.hasReplyTool-1"><span class="tsd-signature-symbol">get</span> hasReplyTool<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates whether the Reply Tool has been added.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasReplyTool</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The Reply Tool has not been added to the viewer."</span><span class="hl-1">);</span><br/><span class="hl-1">} </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The Reply Tool has been added to the viewer."</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasReplyTool</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hasUndoChanges" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Undo<wbr/>Changes</span><a href="#hasUndoChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hasUndoChanges.hasUndoChanges-1"><span class="tsd-signature-symbol">get</span> hasUndoChanges<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets a value indicating whether the pdf viewer can undo document changes.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hasUndoChanges</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">undoChanges</span><span class="hl-1">();</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hasUndoChanges</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hideAnnotations" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>hide<wbr/>Annotations</span><a href="#hideAnnotations" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hideAnnotations.hideAnnotations-1"><span class="tsd-signature-symbol">get</span> hideAnnotations<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Determines whether the annotation layer is hidden.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Hide annotations:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hideAnnotations</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hideAnnotations</p></aside></li>
<li class="tsd-signature" id="hideAnnotations.hideAnnotations-2"><span class="tsd-signature-symbol">set</span> hideAnnotations<span class="tsd-signature-symbol">(</span>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Determines whether the annotation layer is hidden.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Hide annotations:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">hideAnnotations</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>hide: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hideAnnotations</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="highlightManager" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>highlight<wbr/>Manager</span><a href="#highlightManager" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="highlightManager.highlightManager-1"><span class="tsd-signature-symbol">get</span> highlightManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ITextHighlightManager</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the instance of the <code>ITextHighlightManager</code> for managing text highlights in the document.</p>
<p>This property provides access to the <code>ITextHighlightManager</code> which allows you to add, remove,
retrieve, and clear text highlights within the document. If the <code>highlightManager</code> instance
does not already exist, it is created and initialized with the current plugin context.</p>
<h3>Returns</h3><p>The <code>ITextHighlightManager</code> instance for the document.</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">// Access the highlight manager and add a highlight:</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">highlightManager</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">highlightManager</span><span class="hl-1">;</span><br/><span class="hl-2">highlightManager</span><span class="hl-1">.</span><span class="hl-3">highlightTextSegment</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">50</span><span class="hl-1">, { </span><span class="hl-2">color:</span><span class="hl-1"> </span><span class="hl-4">'rgba(255, 255, 0, 0.5)'</span><span class="hl-1"> });</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ITextHighlightManager</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.highlightManager</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="hostElement" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>host<wbr/>Element</span><a href="#hostElement" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="hostElement.hostElement-1"><span class="tsd-signature-symbol">get</span> hostElement<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the main window's host element</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.hostElement</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="isDocumentShared" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Document<wbr/>Shared</span><a href="#isDocumentShared" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="isDocumentShared.isDocumentShared-1"><span class="tsd-signature-symbol">get</span> isDocumentShared<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets a value indicating whether the active document is open in shared mode.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">isDocumentShared</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document is open in shared mode."</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.isDocumentShared</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="isEditModeSticked" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Edit<wbr/>Mode<wbr/>Sticked</span><a href="#isEditModeSticked" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="isEditModeSticked.isEditModeSticked-1"><span class="tsd-signature-symbol">get</span> isEditModeSticked<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns true if the active edit mode is sticked by the user.
Indicates that the stickyBehavior for the active edit button is enabled and the button is checked.
See the toolbarLayout.stickyBehavior property for details.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.isEditModeSticked</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="isInEditorMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>In<wbr/>Editor<wbr/>Mode</span><a href="#isInEditorMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="isInEditorMode.isInEditorMode-1"><span class="tsd-signature-symbol">get</span> isInEditorMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets a value indicating whether the editor mode is currently active.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-2">isInEditorMode</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">isInEditorMode</span><span class="hl-1">;</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Detect the start/end of edit mode</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">isEdit</span><span class="hl-1"> = </span><span class="hl-0">false</span><span class="hl-1">;</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onViewerStateChange</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1"> () {</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">isInEditorMode</span><span class="hl-1"> !== </span><span class="hl-2">isEdit</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">isEdit</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">isInEditorMode</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">isEdit</span><span class="hl-1"> ? </span><span class="hl-4">"Editor Mode activated."</span><span class="hl-1"> : </span><span class="hl-4">"Editor Mode deactivated."</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.isInEditorMode</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="jsFormatFunctions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>js<wbr/>Format<wbr/>Functions</span><a href="#jsFormatFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="jsFormatFunctions.jsFormatFunctions-1"><span class="tsd-signature-symbol">get</span> jsFormatFunctions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>In some specific cases, users may need to override or add new JavaScript formatting functions.
Use the jsFormatFunctions property to achieve this.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Below is an example of how to add a new custom formatting function that appends a postfix to a field value</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">jsFormatFunctions</span><span class="hl-1">.</span><span class="hl-3">customUserFormat</span><span class="hl-1"> = </span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">strValue</span><span class="hl-1">, </span><span class="hl-2">postfix</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-7">return</span><span class="hl-1"> </span><span class="hl-2">strValue</span><span class="hl-1"> + </span><span class="hl-2">postfix</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.jsFormatFunctions</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="language" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>language</span><a href="#language" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="language.language-1"><span class="tsd-signature-symbol">get</span> language<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>language - A property that retrieves the standardized language key based on the provided language option.
The language key is determined by the <code>options.language</code> setting.</p>
<h3>Returns</h3><p>Standardized language key (e.g., 'en', 'ja').</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.language</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="layoutMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>layout<wbr/>Mode</span><a href="#layoutMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="layoutMode.layoutMode-1"><span class="tsd-signature-symbol">get</span> layoutMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LayoutMode</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets or sets the layout mode (0 - Viewer, 1 - AnnotationEditor or 2 - FormEditor).</p>
<h3>Default</h3><p>0</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Set the layout mode to "Form editor"</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">layoutMode</span><span class="hl-1"> = </span><span class="hl-8">2</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">LayoutMode</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.layoutMode</p></aside></li>
<li class="tsd-signature" id="layoutMode.layoutMode-2"><span class="tsd-signature-symbol">set</span> layoutMode<span class="tsd-signature-symbol">(</span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LayoutMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets or sets the layout mode (0 - Viewer, 1 - AnnotationEditor or 2 - FormEditor).</p>
<h3>Default</h3><p>0</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Set the layout mode to "Form editor"</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">layoutMode</span><span class="hl-1"> = </span><span class="hl-8">2</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>mode: <span class="tsd-signature-type">LayoutMode</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.layoutMode</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="leftSidebar" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>left<wbr/>Sidebar</span><a href="#leftSidebar" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="leftSidebar.leftSidebar-1"><span class="tsd-signature-symbol">get</span> leftSidebar<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LeftSidebar</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Left sidebar API.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">leftSidebar</span><span class="hl-1">.</span><span class="hl-3">hide</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">LeftSidebar</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.leftSidebar</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="logLevel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>log<wbr/>Level</span><a href="#logLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="logLevel.logLevel-1"><span class="tsd-signature-symbol">get</span> logLevel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/LogLevel.html" class="tsd-signature-type" data-tsd-kind="Type alias">LogLevel</a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets current log level. Available log levels are: 'None', 'Critical', 'Error', 'Warning', 'Information', 'Debug', 'Trace'. Default level is 'None'.</p>
</div>
<h4 class="tsd-returns-title">Returns <a href="../types/LogLevel.html" class="tsd-signature-type" data-tsd-kind="Type alias">LogLevel</a></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.logLevel</p></aside></li>
<li class="tsd-signature" id="logLevel.logLevel-2"><span class="tsd-signature-symbol">set</span> logLevel<span class="tsd-signature-symbol">(</span>logLvel<span class="tsd-signature-symbol">: </span><a href="../types/LogLevel.html" class="tsd-signature-type" data-tsd-kind="Type alias">LogLevel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets current log level. Available log levels are: 'None', 'Critical', 'Error', 'Warning', 'Information', 'Debug', 'Trace'. Default level is 'None'.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>logLvel: <a href="../types/LogLevel.html" class="tsd-signature-type" data-tsd-kind="Type alias">LogLevel</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.logLevel</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="modificationsState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>modifications<wbr/>State</span><a href="#modificationsState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="modificationsState.modificationsState-1"><span class="tsd-signature-symbol">get</span> modificationsState<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/ModificationsState.html" class="tsd-signature-type" data-tsd-kind="Type alias">ModificationsState</a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets modifications state for active document. Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">modificationsState</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">modificationsState</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">modificationsState</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <a href="../types/ModificationsState.html" class="tsd-signature-type" data-tsd-kind="Type alias">ModificationsState</a></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.modificationsState</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onAfterAddAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>After<wbr/>Add<wbr/>Annotation</span><a href="#onAfterAddAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onAfterAddAnnotation.onAfterAddAnnotation-1"><span class="tsd-signature-symbol">get</span> onAfterAddAnnotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AfterAddAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>After add annotation event.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterAddAnnotation</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AfterAddAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onAfterAddAnnotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onAfterOpen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>After<wbr/>Open</span><a href="#onAfterOpen" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onAfterOpen.onAfterOpen-1"><span class="tsd-signature-symbol">get</span> onAfterOpen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">EventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The event raised when the user changes the viewer theme.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document opened."</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">EventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onAfterOpen</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onAfterRemoveAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>After<wbr/>Remove<wbr/>Annotation</span><a href="#onAfterRemoveAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onAfterRemoveAnnotation.onAfterRemoveAnnotation-1"><span class="tsd-signature-symbol">get</span> onAfterRemoveAnnotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AfterRemoveAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>After remove annotation event.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterRemoveAnnotation</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AfterRemoveAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onAfterRemoveAnnotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onAfterUpdateAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>After<wbr/>Update<wbr/>Annotation</span><a href="#onAfterUpdateAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onAfterUpdateAnnotation.onAfterUpdateAnnotation-1"><span class="tsd-signature-symbol">get</span> onAfterUpdateAnnotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AfterUpdateAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>After update annotation event.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterUpdateAnnotation</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AfterUpdateAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onAfterUpdateAnnotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onBeforeAddAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Before<wbr/>Add<wbr/>Annotation</span><a href="#onBeforeAddAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onBeforeAddAnnotation.onBeforeAddAnnotation-1"><span class="tsd-signature-symbol">get</span> onBeforeAddAnnotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeAddAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Before add annotation event. The event is cancelable.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onBeforeAddAnnotation</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">cancel</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">; </span><span class="hl-5">// set the cancel flag to cancel event.</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeAddAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onBeforeAddAnnotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onBeforeOpen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Before<wbr/>Open</span><a href="#onBeforeOpen" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onBeforeOpen.onBeforeOpen-1"><span class="tsd-signature-symbol">get</span> onBeforeOpen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeOpenEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Occurs immediately before the document opens.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onBeforeOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"A new document will be opened,</span><span class="hl-11">\n</span><span class="hl-4"> payload type(binary or URL): "</span><span class="hl-1"> + </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">type</span><span class="hl-1"> +</span><span class="hl-4">",</span><span class="hl-11">\n</span><span class="hl-4"> payload(bytes or string): "</span><span class="hl-1"> + </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">payload</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeOpenEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onBeforeOpen</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onBeforeRemoveAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Before<wbr/>Remove<wbr/>Annotation</span><a href="#onBeforeRemoveAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onBeforeRemoveAnnotation.onBeforeRemoveAnnotation-1"><span class="tsd-signature-symbol">get</span> onBeforeRemoveAnnotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeRemoveAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Before remove annotation event. The event is cancelable.</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onBeforeRemoveAnnotation</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">cancel</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">; </span><span class="hl-5">// set the cancel flag to cancel event.</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeRemoveAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onBeforeRemoveAnnotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onBeforeUpdateAnnotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Before<wbr/>Update<wbr/>Annotation</span><a href="#onBeforeUpdateAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onBeforeUpdateAnnotation.onBeforeUpdateAnnotation-1"><span class="tsd-signature-symbol">get</span> onBeforeUpdateAnnotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeUpdateAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Before update annotation event. The event is cancelable.</p>
<pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onBeforeUpdateAnnotation</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">cancel</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">; </span><span class="hl-5">// set the cancel flag to cancel event.</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BeforeUpdateAnnotationEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onBeforeUpdateAnnotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onDocumentOpen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Document<wbr/>Open</span><a href="#onDocumentOpen" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onDocumentOpen.onDocumentOpen-1"><span class="tsd-signature-symbol">get</span> onDocumentOpen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentOpenedEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The event indicating document was changed (new document opened, drilled or "back to parent" is issued)</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentOpenedEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onDocumentOpen</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onDocumentProgress" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Document<wbr/>Progress</span><a href="#onDocumentProgress" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onDocumentProgress.onDocumentProgress-1"><span class="tsd-signature-symbol">get</span> onDocumentProgress<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProgressMessage</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The event indicating document load progress</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProgressMessage</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onDocumentProgress</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onDocumentViewOpen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Document<wbr/>View<wbr/>Open</span><a href="#onDocumentViewOpen" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onDocumentViewOpen.onDocumentViewOpen-1"><span class="tsd-signature-symbol">get</span> onDocumentViewOpen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentViewOpenedEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The event indicating document view was changed (new document opened, refreshed, toggled etc)</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DocumentViewOpenedEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onDocumentViewOpen</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Error</span><a href="#onError" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onError.onError-1"><span class="tsd-signature-symbol">get</span> onError<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ErrorEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The event indicating error.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onError</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-2">handleError</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span><br/><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">handleError</span><span class="hl-1">(</span><span class="hl-2">eventArgs</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">message</span><span class="hl-1"> = </span><span class="hl-2">eventArgs</span><span class="hl-1">.</span><span class="hl-2">message</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">message</span><span class="hl-1">.</span><span class="hl-3">indexOf</span><span class="hl-1">(</span><span class="hl-4">"Invalid PDF structure"</span><span class="hl-1">) !== -</span><span class="hl-8">1</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">'Unable to load pdf document, pdf document is broken.'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">'Unexpected error: '</span><span class="hl-1"> + </span><span class="hl-2">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ErrorEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onError</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onThemeChanged" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Theme<wbr/>Changed</span><a href="#onThemeChanged" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onThemeChanged.onThemeChanged-1"><span class="tsd-signature-symbol">get</span> onThemeChanged<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">EventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Occurs when the viewer theme changed by user.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">requireTheme:</span><span class="hl-1"> </span><span class="hl-2">localStorage</span><span class="hl-1">.</span><span class="hl-3">getItem</span><span class="hl-1">(</span><span class="hl-4">'demo_theme'</span><span class="hl-1">) || </span><span class="hl-4">'viewer'</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onThemeChanged</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">localStorage</span><span class="hl-1">.</span><span class="hl-3">setItem</span><span class="hl-1">(</span><span class="hl-4">'demo_theme'</span><span class="hl-1">, </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">theme</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">EventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onThemeChanged</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="onViewerStateChange" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Viewer<wbr/>State<wbr/>Change</span><a href="#onViewerStateChange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="onViewerStateChange.onViewerStateChange-1"><span class="tsd-signature-symbol">get</span> onViewerStateChange<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ChangedEventArgs</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Indicates the viewer state was changed.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ChangedEventArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.onViewerStateChange</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="optionalContentConfig" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>optional<wbr/>Content<wbr/>Config</span><a href="#optionalContentConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="optionalContentConfig.optionalContentConfig-1"><span class="tsd-signature-symbol">get</span> optionalContentConfig<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/OptionalContentConfig.html" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalContentConfig</a><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Default optional content config.
An optional content is a collection of graphics that can be made visible or invisible dynamically.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Use the optionalContentConfig property to print information about all available layers</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">config</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">optionalContentConfig</span><span class="hl-1">;</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">table</span><span class="hl-1">(</span><span class="hl-2">config</span><span class="hl-1">.</span><span class="hl-3">getGroups</span><span class="hl-1">());</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">config</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">optionalContentConfig</span><span class="hl-1">;</span><br/><span class="hl-5">// Turn off optional content group with id "13R":</span><br/><span class="hl-2">config</span><span class="hl-1">.</span><span class="hl-3">setVisibility</span><span class="hl-1">(</span><span class="hl-4">"13R"</span><span class="hl-1">, </span><span class="hl-0">false</span><span class="hl-1">); </span><br/><span class="hl-5">// Repaint visible pages:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">repaint</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/OptionalContentConfig.html" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalContentConfig</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.optionalContentConfig</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="options" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="options.options-1"><span class="tsd-signature-symbol">get</span> options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ViewerOptions.html" class="tsd-signature-type" data-tsd-kind="Class">ViewerOptions</a><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The viewer options.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">options</span><span class="hl-1">.</span><span class="hl-2">zoomByMouseWheel</span><span class="hl-1"> = { </span><span class="hl-2">always:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> };</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyOptions</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ViewerOptions.html" class="tsd-signature-type" data-tsd-kind="Class">ViewerOptions</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.options</p></aside></li>
<li class="tsd-signature" id="options.options-2"><span class="tsd-signature-symbol">set</span> options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ViewerOptions.html" class="tsd-signature-type" data-tsd-kind="Class">ViewerOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>PDF viewer options.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ViewerOptions.html" class="tsd-signature-type" data-tsd-kind="Class">ViewerOptions</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.options</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="pageCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>page<wbr/>Count</span><a href="#pageCount" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="pageCount.pageCount-1"><span class="tsd-signature-symbol">get</span> pageCount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets pages count.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The document opened. Total number of pages: "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.pageCount</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="pageDecoration" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>page<wbr/>Decoration</span><a href="#pageDecoration" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="pageDecoration.pageDecoration-1"><span class="tsd-signature-symbol">get</span> pageDecoration<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PageDecoration</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets or sets page view decoration mode.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PageDecoration</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.pageDecoration</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="pageDisplay" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>page<wbr/>Display</span><a href="#pageDisplay" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="pageDisplay.pageDisplay-1"><span class="tsd-signature-symbol">get</span> pageDisplay<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PageDisplayType</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Page display mode.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PageDisplayType</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.pageDisplay</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="pageIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>page<wbr/>Index</span><a href="#pageIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="pageIndex.pageIndex-1"><span class="tsd-signature-symbol">get</span> pageIndex<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets the active page index.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">// Navigate page with index 9:</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">9</span><span class="hl-1">;</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.pageIndex</p></aside></li>
<li class="tsd-signature" id="pageIndex.pageIndex-2"><span class="tsd-signature-symbol">set</span> pageIndex<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets the active page index.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">// Navigate page with index 9:</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">pageIndex</span><span class="hl-1"> = </span><span class="hl-8">9</span><span class="hl-1">;</span><br/><span class="hl-1">});</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>val: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.pageIndex</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="requiredSupportApiVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>required<wbr/>Support<wbr/>Api<wbr/>Version</span><a href="#requiredSupportApiVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="requiredSupportApiVersion.requiredSupportApiVersion-1"><span class="tsd-signature-symbol">get</span> requiredSupportApiVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the required SupportApi version that is compatible with the current version of the DsPdfViewer.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.requiredSupportApiVersion</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="rightSidebar" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>right<wbr/>Sidebar</span><a href="#rightSidebar" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="rightSidebar.rightSidebar-1"><span class="tsd-signature-symbol">get</span> rightSidebar<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GcRightSidebar</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets right sidebar object.
Use this object if you want to manipulate the right sidebar.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rightSidebar</span><span class="hl-1">.</span><span class="hl-3">show</span><span class="hl-1">(</span><span class="hl-4">'expanded'</span><span class="hl-1">, </span><span class="hl-4">'reply-tool'</span><span class="hl-1">);</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rightSidebar</span><span class="hl-1">.</span><span class="hl-3">toggle</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rightSidebar</span><span class="hl-1">.</span><span class="hl-3">hide</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rightSidebar</span><span class="hl-1">.</span><span class="hl-3">expand</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rightSidebar</span><span class="hl-1">.</span><span class="hl-3">collapse</span><span class="hl-1">(); </span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GcRightSidebar</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.rightSidebar</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="rotation" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>rotation</span><a href="#rotation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="rotation.rotation-1"><span class="tsd-signature-symbol">get</span> rotation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Specifies the rotation in degrees.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-5">// Register an onAfterOpen event handler:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">// Apply 90 degree clockwise rotation:</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rotation</span><span class="hl-1"> = </span><span class="hl-8">90</span><span class="hl-1">;</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Open document:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.rotation</p></aside></li>
<li class="tsd-signature" id="rotation.rotation-2"><span class="tsd-signature-symbol">set</span> rotation<span class="tsd-signature-symbol">(</span>degrees<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Specifies the rotation in degrees.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span><br/><span class="hl-5">// Register an onAfterOpen event handler:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">// Apply 90 degree clockwise rotation:</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">rotation</span><span class="hl-1"> = </span><span class="hl-8">90</span><span class="hl-1">;</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Open document:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Test.pdf'</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>degrees: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.rotation</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="scrollView" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>scroll<wbr/>View</span><a href="#scrollView" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="scrollView.scrollView-1"><span class="tsd-signature-symbol">get</span> scrollView<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the scroll view HTML element.
Note, the left scroll position is calculated by the viewer
automatically - so, usually, you don't need to change left scroll position.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Scroll to the top of the document:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">scrollView</span><span class="hl-1">.</span><span class="hl-2">scrollTop</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.scrollView</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="searcher" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>searcher</span><a href="#searcher" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="searcher.searcher-1"><span class="tsd-signature-symbol">get</span> searcher<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GcPdfSearcher.html" class="tsd-signature-type" data-tsd-kind="Class">GcPdfSearcher</a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Document search worker instance.
Searches currently opened document for a text.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Highlight all search results without opening SearchPanel.</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">searchIterator</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">search</span><span class="hl-1">({ </span><span class="hl-2">Text:</span><span class="hl-1"> </span><span class="hl-4">"test"</span><span class="hl-1">, </span><span class="hl-2">MatchCase:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">, </span><span class="hl-2">HighlightAll:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1">.</span><span class="hl-3">next</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">applyHighlight</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-5">// Iterate all search results</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">searcher</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">searcher</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searchResults</span><span class="hl-1"> = [];</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">searchIterator</span><span class="hl-1"> = </span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">search</span><span class="hl-1">({ </span><span class="hl-2">Text:</span><span class="hl-1"> </span><span class="hl-2">textToSearch</span><span class="hl-1">, </span><span class="hl-2">MatchCase:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searchResult</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1">.</span><span class="hl-3">next</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">highlight</span><span class="hl-1">(</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-7">while</span><span class="hl-1"> (</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1"> && !</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">done</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">searchResultValue</span><span class="hl-1"> = </span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">searchResults</span><span class="hl-1">.</span><span class="hl-3">push</span><span class="hl-1">(</span><span class="hl-4">`index: </span><span class="hl-0">${</span><span class="hl-2">searchResultValue</span><span class="hl-10">.</span><span class="hl-2">ItemIndex</span><span class="hl-0">}</span><span class="hl-4">, text: </span><span class="hl-0">${</span><span class="hl-2">searchResultValue</span><span class="hl-10">.</span><span class="hl-2">DisplayText</span><span class="hl-0">}</span><span class="hl-4">, pageIndex: </span><span class="hl-0">${</span><span class="hl-2">searchResultValue</span><span class="hl-10">.</span><span class="hl-2">PageIndex</span><span class="hl-0">}</span><span class="hl-4">`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">searchResult</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1">.</span><span class="hl-3">next</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">"Search results: "</span><span class="hl-1"> + (</span><span class="hl-2">searchResults</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1"> ? </span><span class="hl-2">searchResults</span><span class="hl-1">.</span><span class="hl-3">join</span><span class="hl-1">(</span><span class="hl-4">"; "</span><span class="hl-1">) : </span><span class="hl-4">"No search results"</span><span class="hl-1">));</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Open the document, find the text 'wildlife' and highlight the first result:</span><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">loadPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">, { </span><span class="hl-2">restoreViewStateOnLoad:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">afterOpenPromise</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Promise</span><span class="hl-1">((</span><span class="hl-2">resolve</span><span class="hl-1">)</span><span class="hl-0">=></span><span class="hl-1">{ </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(()</span><span class="hl-0">=></span><span class="hl-1">{ </span><span class="hl-3">resolve</span><span class="hl-1">(); }); });</span><br/><span class="hl-1"> </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'wetlands.pdf'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">afterOpenPromise</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">findOptions</span><span class="hl-1"> = { </span><span class="hl-2">Text:</span><span class="hl-1"> </span><span class="hl-4">'wildlife'</span><span class="hl-1"> };</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">search</span><span class="hl-1">(</span><span class="hl-2">findOptions</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searchResult</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1">.</span><span class="hl-3">next</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">cancel</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">highlight</span><span class="hl-1">(</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-3">loadPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><p>// Open the document, find the text 'wildlife' and print search results to the console:</p>
<pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">loadPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'wetlands.pdf'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">await</span><span class="hl-1"> (</span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Promise</span><span class="hl-1">((</span><span class="hl-2">resolve</span><span class="hl-1">)</span><span class="hl-0">=></span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(()</span><span class="hl-0">=></span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">resolve</span><span class="hl-1">();</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> }));</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">findOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">Text:</span><span class="hl-1"> </span><span class="hl-4">'wildlife'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">MatchCase:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">WholeWord:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">StartsWith:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">EndsWith:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">Wildcards:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">Proximity:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">SearchBackward:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">HighlightAll:</span><span class="hl-1"> </span><span class="hl-0">true</span><br/><span class="hl-1"> };</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searcher</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">searcher</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">searcher</span><span class="hl-1">.</span><span class="hl-3">search</span><span class="hl-1">(</span><span class="hl-2">findOptions</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">resultsCount</span><span class="hl-1"> = </span><span class="hl-8">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">searchResult</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">do</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">searchResult</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">searchIterator</span><span class="hl-1">.</span><span class="hl-3">next</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// this could be either result or progress message (ItemIndex < 0)</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">.</span><span class="hl-2">ItemIndex</span><span class="hl-1"> >= </span><span class="hl-8">0</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'next search result:'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">resultsCount</span><span class="hl-1">++;</span><br/><span class="hl-1"> } </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">pageCount</span><span class="hl-1"> = </span><span class="hl-2">_doc</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1">.</span><span class="hl-2">totalPageCount</span><span class="hl-1"> || </span><span class="hl-2">_doc</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1">.</span><span class="hl-2">renderedSoFar</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'search progress, page index is '</span><span class="hl-1"> + </span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">value</span><span class="hl-1">.</span><span class="hl-2">PageIndex</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">"Search completed"</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">break</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">while</span><span class="hl-1">(!</span><span class="hl-2">searchResult</span><span class="hl-1">.</span><span class="hl-2">done</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Total results count is '</span><span class="hl-1"> + </span><span class="hl-2">resultsCount</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <a href="GcPdfSearcher.html" class="tsd-signature-type" data-tsd-kind="Class">GcPdfSearcher</a></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.searcher</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="secondToolbar" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>second<wbr/>Toolbar</span><a href="#secondToolbar" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="secondToolbar.secondToolbar-1"><span class="tsd-signature-symbol">get</span> secondToolbar<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecondToolbar</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Second toolbar API.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecondToolbar</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.secondToolbar</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="secondToolbarLayout" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>second<wbr/>Toolbar<wbr/>Layout</span><a href="#secondToolbarLayout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="secondToolbarLayout.secondToolbarLayout-1"><span class="tsd-signature-symbol">get</span> secondToolbarLayout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecondToolbarLayout</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Second toolbar layout.
Use the secondToolbarLayout property to configure available tools.</p>
<h3>Default</h3></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecondToolbarLayout</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.secondToolbarLayout</p></aside></li>
<li class="tsd-signature" id="secondToolbarLayout.secondToolbarLayout-2"><span class="tsd-signature-symbol">set</span> secondToolbarLayout<span class="tsd-signature-symbol">(</span>layout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SecondToolbarLayout</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Second toolbar layout.
Use the secondToolbarLayout property to configure available tools.</p>
<h3>Default</h3></div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>layout: <span class="tsd-signature-type">SecondToolbarLayout</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.secondToolbarLayout</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="signToolStorage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>sign<wbr/>Tool<wbr/>Storage</span><a href="#signToolStorage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="signToolStorage.signToolStorage-1"><span class="tsd-signature-symbol">get</span> signToolStorage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SignToolStorage</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns data storage which can be used to store and retrieve current signature tool settings and images.
Please, note, the storage data depends on current user name, see <a href="DsPdfViewer.html#currentUserName">currentUserName</a> property</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SignToolStorage</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.signToolStorage</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="storage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>storage</span><a href="#storage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="storage.storage-1"><span class="tsd-signature-symbol">get</span> storage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DataStorage</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Data storage for the active document.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">fileData</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">storage</span><span class="hl-1">.</span><span class="hl-3">getItem</span><span class="hl-1">(</span><span class="hl-2">annotation</span><span class="hl-1">.</span><span class="hl-2">fileId</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">storage</span><span class="hl-1">.</span><span class="hl-3">setItem</span><span class="hl-1">(</span><span class="hl-2">fileId</span><span class="hl-1">, </span><span class="hl-2">bytes</span><span class="hl-1">);</span>
</code></pre>
<h3>Example</h3><p>Add Stamp annotation programatically using storage API</p>
<pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">newDocument</span><span class="hl-1">().</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">() { </span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">xhr</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">XMLHttpRequest</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-2">xhr</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'GET'</span><span class="hl-1">, </span><span class="hl-4">'http://localhost/sample.jpg'</span><span class="hl-1">, </span><span class="hl-0">true</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">xhr</span><span class="hl-1">.</span><span class="hl-2">responseType</span><span class="hl-1"> = </span><span class="hl-4">'arraybuffer'</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">xhr</span><span class="hl-1">.</span><span class="hl-3">onload</span><span class="hl-1"> = </span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">e</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">arrayBuffer</span><span class="hl-1"> = </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-2">response</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-2">arrayBuffer</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">// Add Stamp annotation programatically:</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">storage</span><span class="hl-1">.</span><span class="hl-3">setItem</span><span class="hl-1">(</span><span class="hl-4">"sample_file_id_1"</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-9">Uint8Array</span><span class="hl-1">(</span><span class="hl-2">arrayBuffer</span><span class="hl-1">));</span><br/><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">pageSize</span><span class="hl-1"> = </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">getPageSize</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotation</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, {</span><span class="hl-2">annotationType:</span><span class="hl-1"> </span><span class="hl-8">13</span><span class="hl-1">, </span><span class="hl-2">fileId:</span><span class="hl-1"> </span><span class="hl-4">"sample_file_id_1"</span><span class="hl-1">, </span><span class="hl-2">rect:</span><span class="hl-1"> [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-2">pageSize</span><span class="hl-1">.</span><span class="hl-2">height</span><span class="hl-1"> - </span><span class="hl-8">144</span><span class="hl-1">, </span><span class="hl-8">144</span><span class="hl-1">, </span><span class="hl-2">pageSize</span><span class="hl-1">.</span><span class="hl-2">height</span><span class="hl-1">]});</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> };</span><br/><span class="hl-1"> </span><span class="hl-2">xhr</span><span class="hl-1">.</span><span class="hl-3">send</span><span class="hl-1">(); </span><br/><span class="hl-1">});</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DataStorage</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.storage</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="structureTree" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>structure<wbr/>Tree</span><a href="#structureTree" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="structureTree.structureTree-1"><span class="tsd-signature-symbol">get</span> structureTree<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/StructTreeNode.html" class="tsd-signature-type" data-tsd-kind="Type alias">StructTreeNode</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Structure tree data.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-2">selector</span><span class="hl-1">);</span><br/><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">"sample.pdf"</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">structureTree</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">structureTree</span><span class="hl-1">;</span><br/><span class="hl-7">if</span><span class="hl-1">(</span><span class="hl-2">structureTree</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-2">structureTree</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
</code></pre>
<h3>Returns</h3><p>A promise that is resolved with a
<a href="../types/StructTreeNode.html">[]</a> objects that represents the page's structure tree,
or <code>null</code> when no structure tree is present for the page.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/StructTreeNode.html" class="tsd-signature-type" data-tsd-kind="Type alias">StructTreeNode</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.structureTree</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="supportApi" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>support<wbr/>Api</span><a href="#supportApi" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="supportApi.supportApi-1"><span class="tsd-signature-symbol">get</span> supportApi<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ISupportApi</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the SupportApi client.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">supportApi:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1"> } );</span><br/><span class="hl-1"> </span><span class="hl-5">// Contact server and get Support API version.</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">serverVersion</span><span class="hl-1">.</span><span class="hl-3">then</span><span class="hl-1">(</span><span class="hl-0">function</span><span class="hl-1">(</span><span class="hl-2">ver</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The SupportApi version is "</span><span class="hl-1"> + </span><span class="hl-2">ver</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ISupportApi</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.supportApi</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="supportApiVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>support<wbr/>Api<wbr/>Version</span><a href="#supportApiVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="supportApiVersion.supportApiVersion-1"><span class="tsd-signature-symbol">get</span> supportApiVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the connected version of the SupportApi, if available.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.supportApiVersion</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="tempOnPanelChange" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>temp<wbr/>On<wbr/>Panel<wbr/>Change</span><a href="#tempOnPanelChange" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="tempOnPanelChange.tempOnPanelChange-1"><span class="tsd-signature-symbol">get</span> tempOnPanelChange<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Temporary expose event, which occurs on panel change</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventFan</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.tempOnPanelChange</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="toolbarLayout" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>toolbar<wbr/>Layout</span><a href="#toolbarLayout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="toolbarLayout.toolbarLayout-1"><span class="tsd-signature-symbol">get</span> toolbarLayout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PdfToolbarLayout</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Defines the layout of the toolbar for different viewer modes:
viewer, annotationEditor, formEditor.</p>
<h3>Description</h3><p>The full list of the <em>viewer</em> specific toolbar items:</p>
<pre><code class="language-javascript"><span class="hl-4">'open'</span><span class="hl-1">, </span><span class="hl-4">'$navigation'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'text-selection'</span><span class="hl-1">, </span><span class="hl-4">'pan'</span><span class="hl-1">, </span><span class="hl-4">'zoom'</span><span class="hl-1">, </span><span class="hl-4">'$fullscreen'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'text-tools'</span><span class="hl-1">, </span><span class="hl-4">'draw-tools'</span><span class="hl-1">, </span><span class="hl-4">'attachment-tools'</span><span class="hl-1">, </span><br/><span class="hl-4">'form-tools'</span><span class="hl-1">, </span><span class="hl-4">'page-tools'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'rotate'</span><span class="hl-1">, </span><span class="hl-4">'search'</span><span class="hl-1">, </span><span class="hl-4">'page-display'</span><span class="hl-1">, </span><span class="hl-4">'theme-change'</span><span class="hl-1">, </span><span class="hl-4">'download'</span><span class="hl-1">, </span><span class="hl-4">'print'</span><span class="hl-1">, </span><span class="hl-4">'save-as'</span><span class="hl-1">, </span><span class="hl-4">'hide-annotations'</span><span class="hl-1">, </span><span class="hl-4">'form-filler'</span><span class="hl-1">, </span><br/><span class="hl-4">'doc-title'</span><span class="hl-1">, </span><span class="hl-4">'doc-properties'</span><span class="hl-1">, </span><span class="hl-4">'about'</span><span class="hl-1">, </span><span class="hl-4">'share'</span><span class="hl-1">, </span><span class="hl-4">'single-page'</span><span class="hl-1">, </span><span class="hl-4">'continuous-view'</span><span class="hl-1">, </span><span class="hl-4">'page-display'</span><span class="hl-1">, </span><span class="hl-4">'$history'</span><span class="hl-1">, </span><span class="hl-4">'$mousemode'</span><span class="hl-1">, </span><span class="hl-4">'show-edit-tools'</span><span class="hl-1">, </span><span class="hl-4">'show-form-editor'</span>
</code></pre>
<p> The full list of the <em>annotationEditor</em> specific toolbar items:</p>
<pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-4">'edit-select'</span><span class="hl-1">, </span><span class="hl-4">'save-as'</span><span class="hl-1">, </span><span class="hl-4">'share'</span><span class="hl-1">, </span><span class="hl-4">'edit-text'</span><span class="hl-1">, </span><span class="hl-4">'edit-free-text'</span><span class="hl-1">, </span><span class="hl-4">'edit-ink'</span><span class="hl-1">, </span><span class="hl-4">'edit-square'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-circle'</span><span class="hl-1">, </span><span class="hl-4">'edit-line'</span><span class="hl-1">, </span><span class="hl-4">'edit-polyline'</span><span class="hl-1">, </span><span class="hl-4">'edit-polygon'</span><span class="hl-1">, </span><span class="hl-4">'edit-stamp'</span><span class="hl-1">, </span><span class="hl-4">'edit-file-attachment'</span><span class="hl-1">, </span><span class="hl-4">'edit-richmedia'</span><span class="hl-1">, </span><span class="hl-4">'edit-sound'</span><span class="hl-1">, </span><span class="hl-4">'edit-link'</span><span class="hl-1">, </span><span class="hl-4">'edit-highlight'</span><span class="hl-1">, </span><span class="hl-4">'edit-underline'</span><span class="hl-1">, </span><span class="hl-4">'edit-squiggly'</span><span class="hl-1">, </span><span class="hl-4">'edit-strike-out'</span><span class="hl-1">.</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-redact'</span><span class="hl-1">, </span><span class="hl-4">'edit-redact-apply'</span><span class="hl-1">, </span><span class="hl-4">'edit-erase'</span><span class="hl-1">, </span><span class="hl-4">'edit-undo'</span><span class="hl-1">, </span><span class="hl-4">'edit-redo'</span><span class="hl-1">, </span><span class="hl-4">'new-document'</span><span class="hl-1">, </span><span class="hl-4">'new-page'</span><span class="hl-1">, </span><span class="hl-4">'delete-page'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'pdf-organizer'</span>
</code></pre>
<p> The full list of the <em>formEditor</em> specific toolbar items:</p>
<pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-4">'edit-select-field'</span><span class="hl-1">, </span><span class="hl-4">'save-as'</span><span class="hl-1">, </span><span class="hl-4">'share'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-widget-tx-field'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-tx-password'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-tx-text-area'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-checkbox'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-radio'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-widget-btn-push'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-ch-combo'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-ch-list-box'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-tx-comb'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-submit'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-reset'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-erase-field'</span><span class="hl-1">, </span><span class="hl-4">'edit-undo'</span><span class="hl-1">, </span><span class="hl-4">'edit-redo'</span><span class="hl-1">, </span><span class="hl-4">'new-document'</span><span class="hl-1">, </span><span class="hl-4">'new-page'</span><span class="hl-1">, </span><span class="hl-4">'delete-page'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'pdf-organizer'</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Customize the toolbar layout:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">annotationEditor</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">, </span><span class="hl-4">"$split"</span><span class="hl-1">, </span><span class="hl-4">"new-document"</span><span class="hl-1">, </span><span class="hl-4">"edit-ink"</span><span class="hl-1">, </span><span class="hl-4">"edit-text"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">formEditor</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">, </span><span class="hl-4">"$split"</span><span class="hl-1">, </span><span class="hl-4">"edit-widget-tx-field"</span><span class="hl-1">, </span><span class="hl-4">"edit-widget-tx-password"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyToolbarLayout</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Show only Open and Redact buttons:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">supportApi:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1"> });</span><br/><span class="hl-5">// Add annotation editor panel:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotationEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-5">// Change toolbar layout:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1"> = { </span><span class="hl-2">viewer:</span><span class="hl-1"> { </span><span class="hl-2">default:</span><span class="hl-1"> [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">'show-edit-tools'</span><span class="hl-1">]},</span><br/><span class="hl-1"> </span><span class="hl-2">annotationEditor:</span><span class="hl-1"> { </span><span class="hl-2">default:</span><span class="hl-1"> [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">'edit-redact'</span><span class="hl-1">, </span><span class="hl-4">'edit-redact-apply'</span><span class="hl-1">]} };</span><br/><span class="hl-5">// Activate 'Annotation Editor' layout mode:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">layoutMode</span><span class="hl-1"> = </span><span class="hl-8">1</span><span class="hl-1">;</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Make square, circle and line buttons sticky:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">stickyBehavior</span><span class="hl-1"> = [</span><span class="hl-4">"edit-square"</span><span class="hl-1">, </span><span class="hl-4">"edit-circle"</span><span class="hl-1">, </span><span class="hl-4">"edit-line"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyToolbarLayout</span><span class="hl-1">();</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PdfToolbarLayout</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.toolbarLayout</p></aside></li>
<li class="tsd-signature" id="toolbarLayout.toolbarLayout-2"><span class="tsd-signature-symbol">set</span> toolbarLayout<span class="tsd-signature-symbol">(</span>toolbarLayout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PdfToolbarLayout</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Defines the layout of the toolbar for different viewer modes:
viewer, annotationEditor, formEditor.</p>
<h3>Description</h3><p>The full list of the <em>viewer</em> specific toolbar items:</p>
<pre><code class="language-javascript"><span class="hl-4">'text-selection'</span><span class="hl-1">, </span><span class="hl-4">'pan'</span><span class="hl-1">, </span><span class="hl-4">'open'</span><span class="hl-1">, </span><span class="hl-4">'save-as'</span><span class="hl-1">, </span><span class="hl-4">'share'</span><span class="hl-1">, </span><span class="hl-4">'download'</span><span class="hl-1">, </span><span class="hl-4">'print'</span><span class="hl-1">, </span><span class="hl-4">'rotate'</span><span class="hl-1">, </span><span class="hl-4">'theme-change'</span><span class="hl-1">, </span><span class="hl-4">'doc-title'</span><span class="hl-1">, </span><span class="hl-4">'page-display'</span><span class="hl-1">, </span><span class="hl-4">'single-page'</span><span class="hl-1">, </span><span class="hl-4">'continuous-view'</span><span class="hl-1">,</span><br/><span class="hl-4">'$navigation'</span><span class="hl-1"> </span><span class="hl-4">'$refresh'</span><span class="hl-1">, </span><span class="hl-4">'$history'</span><span class="hl-1">, </span><span class="hl-4">'$mousemode'</span><span class="hl-1">, </span><span class="hl-4">'zoom'</span><span class="hl-1">, </span><span class="hl-4">'$fullscreen'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'show-edit-tools'</span><span class="hl-1">, </span><span class="hl-4">'show-form-editor'</span>
</code></pre>
<p> The full list of the <em>annotationEditor</em> specific toolbar items:</p>
<pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-4">'edit-select'</span><span class="hl-1">, </span><span class="hl-4">'save-as'</span><span class="hl-1">, </span><span class="hl-4">'share'</span><span class="hl-1">, </span><span class="hl-4">'edit-text'</span><span class="hl-1">, </span><span class="hl-4">'edit-free-text'</span><span class="hl-1">, </span><span class="hl-4">'edit-ink'</span><span class="hl-1">, </span><span class="hl-4">'edit-square'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-circle'</span><span class="hl-1">, </span><span class="hl-4">'edit-line'</span><span class="hl-1">, </span><span class="hl-4">'edit-polyline'</span><span class="hl-1">, </span><span class="hl-4">'edit-polygon'</span><span class="hl-1">, </span><span class="hl-4">'edit-stamp'</span><span class="hl-1">, </span><span class="hl-4">'edit-file-attachment'</span><span class="hl-1">, </span><span class="hl-4">'edit-richmedia'</span><span class="hl-1">, </span><span class="hl-4">'edit-sound'</span><span class="hl-1">, </span><span class="hl-4">'edit-link'</span><span class="hl-1">, </span><span class="hl-4">'edit-highlight'</span><span class="hl-1">, </span><span class="hl-4">'edit-underline'</span><span class="hl-1">, </span><span class="hl-4">'edit-squiggly'</span><span class="hl-1">, </span><span class="hl-4">'edit-strike-out'</span><span class="hl-1">.</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-redact'</span><span class="hl-1">, </span><span class="hl-4">'edit-redact-apply'</span><span class="hl-1">, </span><span class="hl-4">'edit-erase'</span><span class="hl-1">, </span><span class="hl-4">'edit-undo'</span><span class="hl-1">, </span><span class="hl-4">'edit-redo'</span><span class="hl-1">, </span><span class="hl-4">'new-document'</span><span class="hl-1">, </span><span class="hl-4">'new-page'</span><span class="hl-1">, </span><span class="hl-4">'delete-page'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'pdf-organizer'</span>
</code></pre>
<p> The full list of the <em>formEditor</em> specific toolbar items:</p>
<pre><code class="language-javascript"><span class="hl-1"> </span><span class="hl-4">'edit-select-field'</span><span class="hl-1">, </span><span class="hl-4">'save-as'</span><span class="hl-1">, </span><span class="hl-4">'share'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-widget-tx-field'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-tx-password'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-tx-text-area'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-checkbox'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-radio'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-widget-btn-push'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-ch-combo'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-ch-list-box'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-tx-comb'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-submit'</span><span class="hl-1">, </span><span class="hl-4">'edit-widget-btn-reset'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'edit-erase-field'</span><span class="hl-1">, </span><span class="hl-4">'edit-undo'</span><span class="hl-1">, </span><span class="hl-4">'edit-redo'</span><span class="hl-1">, </span><span class="hl-4">'new-document'</span><span class="hl-1">, </span><span class="hl-4">'new-page'</span><span class="hl-1">, </span><span class="hl-4">'delete-page'</span><span class="hl-1">, </span><span class="hl-4">'$split'</span><span class="hl-1">, </span><span class="hl-4">'pdf-organizer'</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Customize the toolbar layout:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">annotationEditor</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">, </span><span class="hl-4">"$split"</span><span class="hl-1">, </span><span class="hl-4">"new-document"</span><span class="hl-1">, </span><span class="hl-4">"edit-ink"</span><span class="hl-1">, </span><span class="hl-4">"edit-text"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1">.</span><span class="hl-2">formEditor</span><span class="hl-1">.</span><span class="hl-2">default</span><span class="hl-1"> = [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">"save"</span><span class="hl-1">, </span><span class="hl-4">"share"</span><span class="hl-1">, </span><span class="hl-4">"$split"</span><span class="hl-1">, </span><span class="hl-4">"edit-widget-tx-field"</span><span class="hl-1">, </span><span class="hl-4">"edit-widget-tx-password"</span><span class="hl-1">];</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">applyToolbarLayout</span><span class="hl-1">();</span>
</code></pre>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Show only Open and Redact buttons:</span><br/><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">supportApi:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1"> });</span><br/><span class="hl-5">// Add annotation editor panel:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotationEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-5">// Change toolbar layout:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">toolbarLayout</span><span class="hl-1"> = { </span><span class="hl-2">viewer:</span><span class="hl-1"> { </span><span class="hl-2">default:</span><span class="hl-1"> [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">'show-edit-tools'</span><span class="hl-1">]},</span><br/><span class="hl-1"> </span><span class="hl-2">annotationEditor:</span><span class="hl-1"> { </span><span class="hl-2">default:</span><span class="hl-1"> [</span><span class="hl-4">"open"</span><span class="hl-1">, </span><span class="hl-4">'edit-redact'</span><span class="hl-1">, </span><span class="hl-4">'edit-redact-apply'</span><span class="hl-1">]} };</span><br/><span class="hl-5">// Activate 'Annotation Editor' layout mode:</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">layoutMode</span><span class="hl-1"> = </span><span class="hl-8">1</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>toolbarLayout: <span class="tsd-signature-type">PdfToolbarLayout</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.toolbarLayout</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="undoCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>undo<wbr/>Count</span><a href="#undoCount" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="undoCount.undoCount-1"><span class="tsd-signature-symbol">get</span> undoCount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the number of levels(commands) on the undo stack.
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"Undo levels count is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">undoCount</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.undoCount</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="undoIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>undo<wbr/>Index</span><a href="#undoIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="undoIndex.undoIndex-1"><span class="tsd-signature-symbol">get</span> undoIndex<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the index of the current Undo level (command).
This is the Undo command that will be executed on the next call to redoChanges().
Requires SupportApi.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The current Undo level index is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">undoIndex</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.undoIndex</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="undoState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>undo<wbr/>State</span><a href="#undoState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="undoState.undoState-1"><span class="tsd-signature-symbol">get</span> undoState<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>changeName<span class="tsd-signature-symbol">: </span><a href="../types/UndoChangeName.html" class="tsd-signature-type" data-tsd-kind="Type alias">UndoChangeName</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>selectedAnnotation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The current state of the undo store.
Note that this property is read-only, do not programmatically change the elements of the collection.
Use the Undo API methods to change the viewer's editor state.
Undo API properties: hasUndoChanges, hasRedoChanges, undoIndex, undoCount
Undo API methods: undoChanges(), redoChanges()</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>changeName<span class="tsd-signature-symbol">: </span><a href="../types/UndoChangeName.html" class="tsd-signature-type" data-tsd-kind="Type alias">UndoChangeName</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>selectedAnnotation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>annotation<span class="tsd-signature-symbol">: </span><a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">; </span>pageIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.undoState</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="version" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="version.version-1"><span class="tsd-signature-symbol">get</span> version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the current version of the GcDocs PDF viewer.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-3">alert</span><span class="hl-1">(</span><span class="hl-4">"The DsPdfViewer version is "</span><span class="hl-1"> + </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">version</span><span class="hl-1">);</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.version</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="viewMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>view<wbr/>Mode</span><a href="#viewMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="viewMode.viewMode-1"><span class="tsd-signature-symbol">get</span> viewMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ViewMode</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets or sets view mode (single page or continuous).</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ViewMode</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.viewMode</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="viewerPreferences" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>viewer<wbr/>Preferences</span><a href="#viewerPreferences" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="viewerPreferences.viewerPreferences-1"><span class="tsd-signature-symbol">get</span> viewerPreferences<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ViewerPreferences.html" class="tsd-signature-type" data-tsd-kind="Type alias">ViewerPreferences</a><span class="tsd-signature-symbol">></span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets initial viewer preferences.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ViewerPreferences.html" class="tsd-signature-type" data-tsd-kind="Type alias">ViewerPreferences</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.viewerPreferences</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="viewerState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>viewer<wbr/>State</span><a href="#viewerState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="viewerState.viewerState-1"><span class="tsd-signature-symbol">get</span> viewerState<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Model</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets currently viewed document state</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Model</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.viewerState</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="zoomMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>zoom<wbr/>Mode</span><a href="#zoomMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="zoomMode.zoomMode-1"><span class="tsd-signature-symbol">get</span> zoomMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZoomMode</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets the current zoom node.
Accepted values are: 0 - Value, 1 - PageWidth, 2 - WholePage.</p>
<pre><code class="language-javascript"><span class="hl-5">// Set zoom mode to 'WholePage'</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">zoomMode</span><span class="hl-1"> = </span><span class="hl-8">2</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ZoomMode</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.zoomMode</p></aside></li>
<li class="tsd-signature" id="zoomMode.zoomMode-2"><span class="tsd-signature-symbol">set</span> zoomMode<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZoomMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets the current zoom node.
Accepted values are: 0 - Value, 1 - PageWidth, 2 - WholePage.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Set zoom mode to 'WholePage'</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">zoomMode</span><span class="hl-1"> = </span><span class="hl-8">2</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>val: <span class="tsd-signature-type">ZoomMode</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.zoomMode</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="zoomTarget" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>zoom<wbr/>Target</span><a href="#zoomTarget" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="zoomTarget.zoomTarget-1"><span class="tsd-signature-symbol">get</span> zoomTarget<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZoomTarget</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets target element for zoom transformation.
If 'page' is set, each page will be transformed individually (default behavior).
If 'viewport' is set, entire viewport element will be transformed instead.
This is added to prevent issues in some specific cases, see ARJ-4340.
*</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ZoomTarget</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.zoomTarget</p></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="zoomValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>zoom<wbr/>Value</span><a href="#zoomValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature" id="zoomValue.zoomValue-1"><span class="tsd-signature-symbol">get</span> zoomValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets the current zoom percentage level.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Set zoom value to 150%</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">zoomValue</span><span class="hl-1"> = </span><span class="hl-8">150</span><span class="hl-1">;</span>
</code></pre>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.zoomValue</p></aside></li>
<li class="tsd-signature" id="zoomValue.zoomValue-2"><span class="tsd-signature-symbol">set</span> zoomValue<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets/sets the current zoom percentage level.</p>
<h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Set zoom value to 150%</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">zoomValue</span><span class="hl-1"> = </span><span class="hl-8">150</span><span class="hl-1">;</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>val: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from GcPdfViewer.zoomValue</p></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_DsPdfViewer">new <wbr/>Ds<wbr/>Pdf<wbr/>Viewer<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ViewerOptions.html" class="tsd-signature-type" data-tsd-kind="Class">ViewerOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DsPdfViewer.html" class="tsd-signature-type" data-tsd-kind="Class">DsPdfViewer</a><a href="#constructor.new_DsPdfViewer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Document Solutions PDF Viewer constructor.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>element: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
<div class="tsd-comment tsd-typography"><p>root container element or selector pattern used to select the root container element.</p>
</div></li>
<li>
<h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="ViewerOptions.html" class="tsd-signature-type" data-tsd-kind="Class">ViewerOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography"><p>Viewer options. See <a href="ViewerOptions.html">ViewerOptions</a> for further information.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="DsPdfViewer.html" class="tsd-signature-type" data-tsd-kind="Class">DsPdfViewer</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#constructor">constructor</a></p></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="registeredFonts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>registered<wbr/>Fonts</span><a href="#registeredFonts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">registered<wbr/>Fonts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>[fontName: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>clientOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>format<span class="tsd-signature-symbol">: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>resolved<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></div>
<div class="tsd-comment tsd-typography"><p>An object to keep track of registered fonts.
The key is the font name, and the value is an object containing the URL and format of the font.</p>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>fontName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">{ </span>clientOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>format<span class="tsd-signature-symbol">: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>resolved<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> client<wbr/>Only<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5>format<span class="tsd-signature-symbol">: </span><a href="../types/FontFormat.html" class="tsd-signature-type" data-tsd-kind="Type alias">FontFormat</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> resolved<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#registeredFonts">registeredFonts</a></p></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="toggleSidebar" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>toggle<wbr/>Sidebar</span><a href="#toggleSidebar" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">toggle<wbr/>Sidebar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>show<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature" id="__type-4.__type-5"><span class="tsd-signature-symbol">(</span>show<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets of toggles sidebar's panels visibility</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> show: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<p>Inherited from <a href="GcPdfViewer.html">GcPdfViewer</a>.<a href="GcPdfViewer.html#toggleSidebar">toggleSidebar</a></p></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<nav class="tsd-navigation primary">
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li><a href="../index.html">Document <wbr/>Solutions PDF <wbr/>Viewer -<wbr/> v7.2.3</a>
<ul></ul></li></ul></div></details></nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="current tsd-kind-class"><a href="DsPdfViewer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Ds<wbr/>Pdf<wbr/>Viewer</span></a>
<ul>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#findControl" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>find<wbr/>Control</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#i18n" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>i18n</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#activatedEditorMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>activated<wbr/>Editor<wbr/>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addAnnotationEditorPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Annotation<wbr/>Editor<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addArticlesPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Articles<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addAttachmentsPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Attachments<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addDefaultPanels" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Default<wbr/>Panels</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addDocumentListPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Document<wbr/>List<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addFormEditorPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Form<wbr/>Editor<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addLayersPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Layers<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addOutlinePanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Outline<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addReplyTool" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Reply<wbr/>Tool</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addSearchPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Search<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addSharedDocumentsPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Shared<wbr/>Documents<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addStamp" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Stamp</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addStickyNote" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Sticky<wbr/>Note</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addThumbnailsPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Thumbnails<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#addViewAreaStyle" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>View<wbr/>Area<wbr/>Style</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#annotations" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>annotations</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#applyOptions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>apply<wbr/>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#applyToolbarLayout" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>apply<wbr/>Toolbar<wbr/>Layout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#applyViewPortScale" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>apply<wbr/>View<wbr/>Port<wbr/>Scale</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#backgroundColor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>background<wbr/>Color</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#beforeUnloadConfirmation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>before<wbr/>Unload<wbr/>Confirmation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#bringPanelToFront" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>bring<wbr/>Panel<wbr/>To<wbr/>Front</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#canEditDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>can<wbr/>Edit<wbr/>Document</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#changeBoundsOrigin" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>change<wbr/>Bounds<wbr/>Origin</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#changeOrigin" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>change<wbr/>Origin</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#changeOriginToBottom" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>change<wbr/>Origin<wbr/>To<wbr/>Bottom</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#changeOriginToTop" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>change<wbr/>Origin<wbr/>To<wbr/>Top</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#clearHighlightedSegments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>clear<wbr/>Highlighted<wbr/>Segments</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#cloneAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>clone<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#close" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>close</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#closePanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>close<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#collectQuadPoints" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>collect<wbr/>Quad<wbr/>Points</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#confirm" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>confirm</a></li>
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#convertPdfRectToWindowCoordinates" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>convert<wbr/>Pdf<wbr/>Rect<wbr/>To<wbr/>Window<wbr/>Coordinates</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#currentUserName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>current<wbr/>User<wbr/>Name</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#dataLoader" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>data<wbr/>Loader</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#deletePage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#dispose" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>dispose</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#document" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>document</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#download" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>download</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#editMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>edit<wbr/>Mode</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#errorHandler" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>error<wbr/>Handler</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#eventBus" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>event<wbr/>Bus</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#execCopyAction" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>exec<wbr/>Copy<wbr/>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#execCutAction" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>exec<wbr/>Cut<wbr/>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#execDeleteAction" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>exec<wbr/>Delete<wbr/>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#execPasteAction" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>exec<wbr/>Paste<wbr/>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#executeTask" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>execute<wbr/>Task</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#fileData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>file<wbr/>Data</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#fileName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>file<wbr/>Name</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#fileSize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>file<wbr/>Size</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#fileUrl" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>file<wbr/>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#findAnnotations" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>find<wbr/>Annotations</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#fingerprint" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>fingerprint</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#gcPdfVersion" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>gc<wbr/>Pdf<wbr/>Version</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getDocumentInformation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Document<wbr/>Information</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getDocumentSecurity" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Document<wbr/>Security</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getEvent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Event</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getPageLocation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Page<wbr/>Location</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getPageRotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Page<wbr/>Rotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getPageSize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Page<wbr/>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getPageTabs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Page<wbr/>Tabs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getPanelState" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Panel<wbr/>State</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getSelectedText" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Selected<wbr/>Text</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getSharedDocuments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Shared<wbr/>Documents</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getSignatureInfo" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Signature<wbr/>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#getViewPort" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>View<wbr/>Port</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goBack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>Back</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goForward" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>Forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goToFirstPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>To<wbr/>First<wbr/>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goToLastPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>To<wbr/>Last<wbr/>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goToNextPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>To<wbr/>Next<wbr/>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goToPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>To<wbr/>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goToPageNumber" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>To<wbr/>Page<wbr/>Number</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#goToPrevPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>go<wbr/>To<wbr/>Prev<wbr/>Page</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Changes</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasCopyData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Copy<wbr/>Data</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Document</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasForm" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Form</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasPersistentConnection" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Persistent<wbr/>Connection</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasRedoChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Redo<wbr/>Changes</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasReplyTool" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Reply<wbr/>Tool</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hasUndoChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>has<wbr/>Undo<wbr/>Changes</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hideAnnotations" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>hide<wbr/>Annotations</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hideSecondToolbar" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>hide<wbr/>Second<wbr/>Toolbar</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#highlight" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>highlight</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#highlightManager" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>highlight<wbr/>Manager</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#highlightTextSegment" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>highlight<wbr/>Text<wbr/>Segment</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#hostElement" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>host<wbr/>Element</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#invalidate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>invalidate</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#isDocumentShared" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>is<wbr/>Document<wbr/>Shared</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#isEditModeSticked" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>is<wbr/>Edit<wbr/>Mode<wbr/>Sticked</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#isFontUrlRegistered" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Font<wbr/>Url<wbr/>Registered</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#isInEditorMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>is<wbr/>In<wbr/>Editor<wbr/>Mode</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#jsFormatFunctions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>js<wbr/>Format<wbr/>Functions</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#language" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>language</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#layoutMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>layout<wbr/>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#layoutPanels" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>layout<wbr/>Panels</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#leftSidebar" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>left<wbr/>Sidebar</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#load" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#loadAndScrollPageIntoView" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>load<wbr/>And<wbr/>Scroll<wbr/>Page<wbr/>Into<wbr/>View</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#loadDocumentList" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>load<wbr/>Document<wbr/>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#loadSharedDocuments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>load<wbr/>Shared<wbr/>Documents</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#lockAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>lock<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#logLevel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>log<wbr/>Level</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#markAnnotationLayerDirty" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>mark<wbr/>Annotation<wbr/>Layer<wbr/>Dirty</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#modificationsState" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>modifications<wbr/>State</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#newDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>new<wbr/>Document</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#newPage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>new<wbr/>Page</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onAfterAddAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>After<wbr/>Add<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onAfterOpen" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>After<wbr/>Open</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onAfterRemoveAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>After<wbr/>Remove<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onAfterUpdateAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>After<wbr/>Update<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onBeforeAddAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Before<wbr/>Add<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onBeforeOpen" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Before<wbr/>Open</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onBeforeRemoveAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Before<wbr/>Remove<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onBeforeUpdateAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Before<wbr/>Update<wbr/>Annotation</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onDocumentOpen" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Document<wbr/>Open</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onDocumentProgress" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Document<wbr/>Progress</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onDocumentViewOpen" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Document<wbr/>View<wbr/>Open</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onError" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Error</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onThemeChanged" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Theme<wbr/>Changed</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#onViewerStateChange" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>on<wbr/>Viewer<wbr/>State<wbr/>Change</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#open" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>open</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#openLocalFile" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>open<wbr/>Local<wbr/>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#openPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>open<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#openSharedDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>open<wbr/>Shared<wbr/>Document</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#openSharedDocumentByIndex" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Index</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#openSharedDocumentByName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>open<wbr/>Shared<wbr/>Document<wbr/>By<wbr/>Name</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#optionalContentConfig" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>optional<wbr/>Content<wbr/>Config</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>options</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#pageCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>page<wbr/>Count</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#pageDecoration" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>page<wbr/>Decoration</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#pageDisplay" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>page<wbr/>Display</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#pageIndex" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>page<wbr/>Index</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#pdfStringToDate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>pdf<wbr/>String<wbr/>To<wbr/>Date</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#print" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>print</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#redoChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>redo<wbr/>Changes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#registerFallbackFont" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>register<wbr/>Fallback<wbr/>Font</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#registerFont" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>register<wbr/>Font</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#registeredFonts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>registered<wbr/>Fonts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#removeAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#removeViewAreaStyle" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>View<wbr/>Area<wbr/>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#repaint" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>repaint</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#repaintTextLayer" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>repaint<wbr/>Text<wbr/>Layer</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#requiredSupportApiVersion" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>required<wbr/>Support<wbr/>Api<wbr/>Version</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#resetDocument" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>reset<wbr/>Document</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#resetForm" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>reset<wbr/>Form</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#resolvePageIndex" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>resolve<wbr/>Page<wbr/>Index</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#resolveRegisteredFonts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>resolve<wbr/>Registered<wbr/>Fonts</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#rightSidebar" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>right<wbr/>Sidebar</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#rotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>rotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#save" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>save</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#saveAsImages" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>save<wbr/>As<wbr/>Images</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#saveChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>save<wbr/>Changes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#scrollAnnotationIntoView" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>scroll<wbr/>Annotation<wbr/>Into<wbr/>View</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#scrollPageIntoView" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>scroll<wbr/>Page<wbr/>Into<wbr/>View</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#scrollView" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>scroll<wbr/>View</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>search</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#searcher" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>searcher</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#secondToolbar" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>second<wbr/>Toolbar</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#secondToolbarLayout" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>second<wbr/>Toolbar<wbr/>Layout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#selectAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>select<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setActiveBottomPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Active<wbr/>Bottom<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setActiveTopPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Active<wbr/>Top<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setAnnotationBounds" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Annotation<wbr/>Bounds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setPageRotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Page<wbr/>Rotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setPageSize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Page<wbr/>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setPageTabs" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Page<wbr/>Tabs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#setTheme" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Theme</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showAnnotationFocusOutline" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Annotation<wbr/>Focus<wbr/>Outline</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showFormFiller" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Form<wbr/>Filler</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showMessage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showPanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showPdfOrganizer" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Pdf<wbr/>Organizer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showReplaceText" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Replace<wbr/>Text</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showSecondToolbar" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Second<wbr/>Toolbar</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#showSignTool" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>show<wbr/>Sign<wbr/>Tool</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#signToolStorage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>sign<wbr/>Tool<wbr/>Storage</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#storage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>storage</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#structureTree" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>structure<wbr/>Tree</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#submitForm" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>submit<wbr/>Form</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#supportApi" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>support<wbr/>Api</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#supportApiVersion" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>support<wbr/>Api<wbr/>Version</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#tempOnPanelChange" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>temp<wbr/>On<wbr/>Panel<wbr/>Change</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#toggleSidebar" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>toggle<wbr/>Sidebar</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#toolbarLayout" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>toolbar<wbr/>Layout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#triggerEvent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>trigger<wbr/>Event</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#undoChanges" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>undo<wbr/>Changes</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#undoCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>undo<wbr/>Count</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#undoIndex" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>undo<wbr/>Index</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#undoState" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>undo<wbr/>State</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#unlockAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>unlock<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#unselectAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>unselect<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#updateAnnotation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>Annotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#updateAnnotations" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>Annotations</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#updateGroupFieldValue" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>Group<wbr/>Field<wbr/>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#updatePanel" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>Panel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#validateForm" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate<wbr/>Form</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#version" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>version</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#viewMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>view<wbr/>Mode</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#viewerPreferences" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>viewer<wbr/>Preferences</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#viewerState" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>viewer<wbr/>State</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#zoomMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>zoom<wbr/>Mode</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#zoomTarget" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>zoom<wbr/>Target</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="DsPdfViewer.html#zoomValue" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>zoom<wbr/>Value</a></li></ul></li></ul></nav></div></div>
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>