@grapecity/gcpdfviewer

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ViewerOptions | 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="ViewerOptions.html">ViewerOptions</a></li></ul> <h1>Class ViewerOptions</h1></div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"><p>GcDocs PDF Viewer options class.</p> </div></section> <section class="tsd-panel tsd-hierarchy"> <h4>Hierarchy</h4> <ul class="tsd-hierarchy"> <li><span class="target">ViewerOptions</span></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">Properties</h3> <div class="tsd-index-list"><a href="ViewerOptions.html#allowedTools" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>allowed<wbr/>Tools</span></a> <a href="ViewerOptions.html#baseUrl" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>base<wbr/>Url</span></a> <a href="ViewerOptions.html#cMapPacked" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>c<wbr/>Map<wbr/>Packed</span></a> <a href="ViewerOptions.html#cMapUrl" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>c<wbr/>Map<wbr/>Url</span></a> <a href="ViewerOptions.html#caret" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>caret</span></a> <a href="ViewerOptions.html#coordinatesOrigin" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>coordinates<wbr/>Origin</span></a> <a href="ViewerOptions.html#coordinatesPrecision" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>coordinates<wbr/>Precision</span></a> <a href="ViewerOptions.html#customIcons" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>custom<wbr/>Icons</span></a> <a href="ViewerOptions.html#disableFeatures" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>disable<wbr/>Features</span></a> <a href="ViewerOptions.html#disableHistory" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>disable<wbr/>History</span></a> <a href="ViewerOptions.html#disablePageLabels" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>disable<wbr/>Page<wbr/>Labels</span></a> <a href="ViewerOptions.html#documentListUrl" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>document<wbr/>List<wbr/>Url</span></a> <a href="ViewerOptions.html#editorDefaults" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>editor<wbr/>Defaults</span></a> <a href="ViewerOptions.html#enableXfa" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>enable<wbr/>Xfa</span></a> <a href="ViewerOptions.html#externalLinkTarget" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>external<wbr/>Link<wbr/>Target</span></a> <a href="ViewerOptions.html#fieldsAppearance" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>fields<wbr/>Appearance</span></a> <a href="ViewerOptions.html#file" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>file</span></a> <a href="ViewerOptions.html#formFiller" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>form<wbr/>Filler</span></a> <a href="ViewerOptions.html#friendlyFileName" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>friendly<wbr/>File<wbr/>Name</span></a> <a href="ViewerOptions.html#hideAnnotationPopups" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>hide<wbr/>Annotation<wbr/>Popups</span></a> <a href="ViewerOptions.html#hideAnnotationTypes" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>hide<wbr/>Annotation<wbr/>Types</span></a> <a href="ViewerOptions.html#ignoreInitialView" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>ignore<wbr/>Initial<wbr/>View</span></a> <a href="ViewerOptions.html#jsExecutionConfig" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>js<wbr/>Execution<wbr/>Config</span></a> <a href="ViewerOptions.html#keepFileData" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>keep<wbr/>File<wbr/>Data</span></a> <a href="ViewerOptions.html#language" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>language</span></a> <a href="ViewerOptions.html#lockOpenTimeout" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>lock<wbr/>Open<wbr/>Timeout</span></a> <a href="ViewerOptions.html#logLevel" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>log<wbr/>Level</span></a> <a href="ViewerOptions.html#maxCanvasPixels" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>max<wbr/>Canvas<wbr/>Pixels</span></a> <a href="ViewerOptions.html#newDocumentFileName" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>new<wbr/>Document<wbr/>File<wbr/>Name</span></a> <a href="ViewerOptions.html#onBeforeCloseContextMenu" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>on<wbr/>Before<wbr/>Close<wbr/>Context<wbr/>Menu</span></a> <a href="ViewerOptions.html#onBeforeOpenContextMenu" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>on<wbr/>Before<wbr/>Open<wbr/>Context<wbr/>Menu</span></a> <a href="ViewerOptions.html#onInitialized" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>on<wbr/>Initialized</span></a> <a href="ViewerOptions.html#openParameters" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>open<wbr/>Parameters</span></a> <a href="ViewerOptions.html#pageDisplay" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>page<wbr/>Display</span></a> <a href="ViewerOptions.html#password" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>password</span></a> <a href="ViewerOptions.html#renderInteractiveForms" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>render<wbr/>Interactive<wbr/>Forms</span></a> <a href="ViewerOptions.html#renderer" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>renderer</span></a> <a href="ViewerOptions.html#replyTool" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>reply<wbr/>Tool</span></a> <a href="ViewerOptions.html#requireTheme" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>require<wbr/>Theme</span></a> <a href="ViewerOptions.html#restoreViewStateOnLoad" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>restore<wbr/>View<wbr/>State<wbr/>On<wbr/>Load</span></a> <a href="ViewerOptions.html#saveAsOptions" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>save<wbr/>As<wbr/>Options</span></a> <a href="ViewerOptions.html#saveSettings" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>save<wbr/>Settings</span></a> <a href="ViewerOptions.html#secondToolbar" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>second<wbr/>Toolbar</span></a> <a href="ViewerOptions.html#sharing" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>sharing</span></a> <a href="ViewerOptions.html#shortcuts" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>shortcuts</span></a> <a href="ViewerOptions.html#showContextMenuOnSelection" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>show<wbr/>Context<wbr/>Menu<wbr/>On<wbr/>Selection</span></a> <a href="ViewerOptions.html#signTool" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>sign<wbr/>Tool</span></a> <a href="ViewerOptions.html#snapAlignment" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>snap<wbr/>Alignment</span></a> <a href="ViewerOptions.html#stamp" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>stamp</span></a> <a href="ViewerOptions.html#supportApi" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>support<wbr/>Api</span></a> <a href="ViewerOptions.html#textMarkupContextMenu" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>text<wbr/>Markup<wbr/>Context<wbr/>Menu</span></a> <a href="ViewerOptions.html#theme" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>theme</span></a> <a href="ViewerOptions.html#themes" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>themes</span></a> <a href="ViewerOptions.html#useCanvasForSelection" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>use<wbr/>Canvas<wbr/>For<wbr/>Selection</span></a> <a href="ViewerOptions.html#useFloatingSearchBar" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>use<wbr/>Floating<wbr/>Search<wbr/>Bar</span></a> <a href="ViewerOptions.html#useNativeContextMenu" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>use<wbr/>Native<wbr/>Context<wbr/>Menu</span></a> <a href="ViewerOptions.html#userData" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>user<wbr/>Data</span></a> <a href="ViewerOptions.html#userName" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>user<wbr/>Name</span></a> <a href="ViewerOptions.html#workerSrc" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>worker<wbr/>Src</span></a> <a href="ViewerOptions.html#zoomByMouseWheel" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>zoom<wbr/>By<wbr/>Mouse<wbr/>Wheel</span></a> <a href="ViewerOptions.html#zoomOptions" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><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>zoom<wbr/>Options</span></a> </div></section></div></details></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"><a id="allowedTools" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>allowed<wbr/>Tools</span><a href="#allowedTools" aria-label="Permalink" class="tsd-anchor-icon"><svg class="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> <div class="tsd-signature">allowed<wbr/>Tools<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>annotationEditor<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">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"annotations"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fields"</span><span class="tsd-signature-symbol">; </span>formEditor<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">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"annotations"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fields"</span><span class="tsd-signature-symbol">; </span>viewer<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">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"annotations"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fields"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <div class="tsd-comment tsd-typography"><p>Use this option to enable annotation tools from the form editor or field tools from the annotation editor.</p> <h3>Default</h3><pre><code class="language-javascript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-14">annotationEditor</span><span class="hl-1">: </span><span class="hl-4">'annotations'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-14">formEditor</span><span class="hl-1">: </span><span class="hl-4">'fields'</span><br/><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">options</span><span class="hl-1">.</span><span class="hl-2">allowedTools</span><span class="hl-1"> = { </span><span class="hl-2">formEditor:</span><span class="hl-1"> </span><span class="hl-4">'all'</span><span class="hl-1"> };</span> </code></pre> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> annotation<wbr/>Editor<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">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"annotations"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fields"</span></h5></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> form<wbr/>Editor<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">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"annotations"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fields"</span></h5></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> viewer<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">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"annotations"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fields"</span></h5></li></ul></div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="baseUrl" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base<wbr/>Url</span><a href="#baseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">base<wbr/>Url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div> <div class="tsd-comment tsd-typography"><p>Used by form submission and for theme urls.</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">baseUrl:</span><span class="hl-1"> </span><span class="hl-4">"http://localhost/mysite/"</span><span class="hl-1"> });</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="cMapPacked" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>c<wbr/>Map<wbr/>Packed</span><a href="#cMapPacked" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">c<wbr/>Map<wbr/>Packed<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>Indicates if the viewer should look for a compressed version of the CMap file with the extension '.bin'.</p> <h3>Default</h3><p>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">cMapPacked:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1"> } );</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="cMapUrl" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>c<wbr/>Map<wbr/>Url</span><a href="#cMapUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">c<wbr/>Map<wbr/>Url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>The URI to a folder where the external font CMap tables are stored.</p> <h3>Default</h3><p>'resources/bcmaps/'</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">cMapUrl:</span><span class="hl-1"> </span><span class="hl-4">"../data/cmaps/"</span><span class="hl-1"> } );</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="caret" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>caret</span><a href="#caret" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">caret<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>allowForPan<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>caretBlinkTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>caretStopBlinkTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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></div> <div class="tsd-comment tsd-typography"><p>Text selection cursor settings.</p> <h3>Description</h3><pre><code class="language-javascript"><span class="hl-2">Settings</span><span class="hl-1"> </span><span class="hl-14">description</span><span class="hl-1">:</span><br/><span class="hl-2">caretBlinkTime</span><span class="hl-1"> - </span><span class="hl-2">milliseconds</span><span class="hl-1">, </span><span class="hl-2">caret</span><span class="hl-1"> </span><span class="hl-2">blink</span><span class="hl-1"> </span><span class="hl-2">period</span><br/><span class="hl-2">caretStopBlinkTime</span><span class="hl-1"> - </span><span class="hl-2">milliseconds</span><span class="hl-1">, </span><span class="hl-2">stop</span><span class="hl-1"> </span><span class="hl-2">caret</span><span class="hl-1"> </span><span class="hl-2">blink</span><span class="hl-1"> </span><span class="hl-2">time</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1"> - </span><span class="hl-2">don</span><span class="hl-4">'t sto</span><span class="hl-15">p</span><br/><span class="hl-2">color</span><span class="hl-1"> - </span><span class="hl-2">The</span><span class="hl-1"> </span><span class="hl-2">caret</span><span class="hl-1"> </span><span class="hl-2">color</span><br/><span class="hl-2">width</span><span class="hl-1"> - </span><span class="hl-2">The</span><span class="hl-1"> </span><span class="hl-2">caret</span><span class="hl-1"> </span><span class="hl-2">width</span><br/><span class="hl-2">allowForPan</span><span class="hl-1"> - </span><span class="hl-2">Allow</span><span class="hl-1"> </span><span class="hl-2">to</span><span class="hl-1"> </span><span class="hl-2">move</span><span class="hl-1"> </span><span class="hl-2">caret</span><span class="hl-1"> </span><span class="hl-2">using</span><span class="hl-1"> </span><span class="hl-2">keys</span><span class="hl-1"> </span><span class="hl-2">even</span><span class="hl-1"> </span><span class="hl-2">when</span><span class="hl-1"> </span><span class="hl-2">pan</span><span class="hl-1"> </span><span class="hl-2">tool</span><span class="hl-1"> </span><span class="hl-2">activated</span><span class="hl-1">.</span> </code></pre> <h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Hide the caret:</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">caret:</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">// Change the caret color and width:</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">caret:</span><span class="hl-1"> {</span><span class="hl-4">"color"</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-4">"#ff0000"</span><span class="hl-1">, </span><span class="hl-4">"width"</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-8">2</span><span class="hl-1">} } );</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="coordinatesOrigin" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>coordinates<wbr/>Origin</span><a href="#coordinatesOrigin" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">coordinates<wbr/>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><span class="tsd-signature-symbol"> = 'TopLeft'</span></div> <div class="tsd-comment tsd-typography"><p>Origin coordinates for the PDF page. The option is used for a properties panel of the Annotation and Form editor.</p> <h3>Default</h3><p>TopLeft</p> <h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Change the coordinates origin to bottom/left point:</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">coordinatesOrigin:</span><span class="hl-1"> </span><span class="hl-4">"BottomLeft"</span><span class="hl-1"> } );</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="coordinatesPrecision" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>coordinates<wbr/>Precision</span><a href="#coordinatesPrecision" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">coordinates<wbr/>Precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-comment tsd-typography"><p>Annotation coordinates round precision. Used by the Annotation and Form editor.</p> <h3>Default</h3><p>1</p> <h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Change the default rounding precision to 0.001:</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">coordinatesPrecision:</span><span class="hl-1"> </span><span class="hl-8">0.001</span><span class="hl-1"> } );</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="customIcons" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>custom<wbr/>Icons</span><a href="#customIcons" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">custom<wbr/>Icons<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>[iconKey: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div> <div class="tsd-comment tsd-typography"><p>Use this option to change the default SVG icons to custom ones. Available icon keys: 'undo2', 'font-bold', 'font-italic', 'checkbox-checked', 'checkbox-unchecked', 'close', 'aspect-ratio', 'search', 'chevron', 'chevron-accent', 'animated-spinner', 'drag-handle', 'download', 'keyboard', 'brush', 'image', 'image-list', 'save', 'theme-change', 'single-page', 'continuous-view', 'view-mode', 'show-view-tools', 'show-edit-tools', 'show-form-editor', 'toggle-annotation-properties', 'toggle-form-properties', 'edit-converted-to-content', 'edit-free-text', 'edit-ink', 'edit-text', 'edit-square', 'edit-line', 'edit-link', 'edit-circle', 'edit-stamp', 'add-stamp-accent', 'edit-sign-tool', 'edit-file-attachment', 'edit-sound', 'edit-polyline', 'edit-polygon', 'edit-popup', 'edit-redact', 'edit-redact-apply', 'edit-redact-applied', 'edit-unknown-type', 'edit-widget-signature', 'edit-widget-tx-field', 'edit-widget-tx-text-area', 'edit-widget-tx-comb', 'edit-widget-tx-password', 'edit-widget-btn-checkbox', 'edit-widget-btn-radio', 'edit-widget-btn-push', 'edit-widget-btn-submit', 'edit-widget-btn-reset', 'edit-widget-ch-combo', 'edit-widget-ch-list-box', 'edit-widget-unknown-type', 'edit-undo', 'edit-redo', 'remove-attachment', 'edit-select', 'edit-erase', 'form-filler', 'field-invalid', 'new-document', 'new-page', 'delete-page', 'print', 'rotate', 'confirm-ok', 'confirm-cancel', 'open', 'open-pdf', 'text-selection', 'hide-annotations', 'pan', 'bookmarks', 'structure-tree', 'layers', 'thumbnails', 'articles', 'attachments', 'documents-list', 'share', 'shared-documents-list', 'view-mode-on', 'view-mode-off', 'edit-mode-on', 'edit-mode-off', 'remove-user', 'doc-properties', 'about', 'pdf-doc-title', 'close-icon-sm', 'menu-dots', 'comments-status-accepted', 'comments-status-cancelled', 'comments-status-completed', 'comments-status-rejected', 'context-copy', 'context-paste', 'context-cut', 'context-delete', 'move-to-top-page', 'move-to-bottom-page', 'arrow-expand-horizontal', 'arrow-expand-all', 'magnify-minus-outline', 'magnify-plus-outline', 'magnify', 'text-tools', 'draw-tools', 'attachment-tools', 'form-tools', 'page-tools', 'resize-handle-h'.</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">customIcons:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">'open'</span><span class="hl-2">:</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 d="M9.516 14.016q1.875 0 3.188-1.313t1.313-3.188-1.313-3.188-3.188-1.313-3.188 1.313-1.313 3.188 1.313 3.188 3.188 1.313zM15.516 14.016l4.969 4.969-1.5 1.5-4.969-4.969v-0.797l-0.281-0.281q-1.781 1.547-4.219 1.547-2.719 0-4.617-1.875t-1.898-4.594 1.898-4.617 4.617-1.898 4.594 1.898 1.875 4.617q0 0.984-0.469 2.227t-1.078 1.992l0.281 0.281h0.797z"></path></svg>'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'search'</span><span class="hl-2">:</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 d="M9.516 14.016q1.875 0 3.188-1.313t1.313-3.188-1.313-3.188-3.188-1.313-3.188 1.313-1.313 3.188 1.313 3.188 3.188 1.313zM15.516 14.016l4.969 4.969-1.5 1.5-4.969-4.969v-0.797l-0.281-0.281q-1.781 1.547-4.219 1.547-2.719 0-4.617-1.875t-1.898-4.594 1.898-4.617 4.617-1.898 4.594 1.898 1.875 4.617q0 0.984-0.469 2.227t-1.078 1.992l0.281 0.281h0.797z"></path></svg>'</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span> </code></pre> </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>iconKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="disableFeatures" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>disable<wbr/>Features</span><a href="#disableFeatures" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">disable<wbr/>Features<span class="tsd-signature-symbol">?:</span> <a href="../types/ViewerFeatureName.html" class="tsd-signature-type" data-tsd-kind="Type alias">ViewerFeatureName</a><span class="tsd-signature-symbol">[]</span></div> <div class="tsd-comment tsd-typography"><p>Use the disableFeatures option to disable certain features of the DsPdfViewer depending on your company security policy. Note, you can specify the disableFeatures option only during the DsPdfViewer initialization.</p> <h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Disable DragAndDrop operations, JavaScript actions, File and Sound attachments:</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">disableFeatures:</span><span class="hl-1"> [</span><span class="hl-4">'DragAndDrop'</span><span class="hl-1">, </span><span class="hl-4">'JavaScript'</span><span class="hl-1">, </span><span class="hl-4">'AllAttachments'</span><span class="hl-1">] } );</span> </code></pre> <h3>Example</h3><pre><code class="language-javascript"><span class="hl-5">// Disable DragAndDrop for the DsPdfViewer:</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-2">selector</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">disableFeatures:</span><span class="hl-1"> [</span><span class="hl-4">'DragAndDrop'</span><span class="hl-1">]</span><br/><span class="hl-1">});</span> </code></pre> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="disableHistory" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>disable<wbr/>History</span><a href="#disableHistory" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="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">disable<wbr/>History<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>If set to true, disables browser history during navigation inside PDF document.</p> <h3>Example</h3><pre><code class="lan