@grapecity/gcpdfviewer

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SignToolSettings | 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="SignToolSettings.html">SignToolSettings</a></li></ul> <h1>Type alias SignToolSettings</h1></div> <div class="tsd-signature">SignToolSettings: { afterAdd?: ((result: { annotation: <a href="../classes/AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>; pageIndex: number }) => void); afterShow?: ((signatureDialog: any) => void); autoResizeCanvas?: boolean; beforeAdd?: ((activeTool: any, signatureDialog: any) => boolean); beforeHide?: ((signatureDialog: any) => boolean); beforeShow?: ((signatureDialog: any) => boolean); bold?: boolean; canvasSize?: { height: number; width: number }; convertToContent?: boolean; destinationScale?: number; dialogLocation?: "Center" | "Top" | "Right" | "Bottom" | "Left" | { x: number; y: number }; fontName?: string; fontNames?: string[]; fontSize?: number; hasImage?: boolean; hideDialogFooter?: boolean; hideDialogTitle?: boolean; hideSaveSignature?: boolean; hideTabs?: boolean; hideToolbar?: boolean; italic?: boolean; location?: "Center" | "Top" | "Right" | "Bottom" | "Left" | "TopLeft" | "TopRight" | "BottomRight" | "BottomLeft" | { x: number; y: number }; pageIndex?: number; penColor?: string; penWidth?: number; ruler?: { Draw: <a href="RulerLine.html" class="tsd-signature-type" data-tsd-kind="Type alias">RulerLine</a>[] | false; Image: <a href="RulerLine.html" class="tsd-signature-type" data-tsd-kind="Type alias">RulerLine</a>[] | false; Type: <a href="RulerLine.html" class="tsd-signature-type" data-tsd-kind="Type alias">RulerLine</a>[] | false } | false; saveSignature?: boolean; selectedTab?: "Type" | "Draw" | "Image"; subject?: string; tabs?: ("Type" | "Draw" | "Image")[]; text?: string; textColor?: string; title?: string }</div> <div class="tsd-comment tsd-typography">Appearance settings for the Signature Tool dialog. </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> afterAdd?: ((result: { annotation: <a href="../classes/AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>; pageIndex: number }) => void)</h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature" id="__type.__type-1.__type-2">(result: { annotation: <a href="../classes/AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>; pageIndex: number }): void</li> <li class="tsd-description"> <div class="tsd-comment tsd-typography">The afterAdd event handler will be called when the result annotation is added and signature dialog is closed. <h3>Example</h3><pre><code class="language-javascript">var viewer = new DsPdfViewer("#root"); viewer.options.signTool = { afterAdd: function() { // Put your code here. return true; }, }; </code></pre> <h3>Example</h3><pre><code class="language-javascript">// Update the title of the result annotation and convert the annotation to content: var viewer = new DsPdfViewer(selector, { supportApi: { apiUrl: 'http://127.0.0.1:5001/support-api/gc-pdf-viewer', webSocketUrl: false }, signTool: { afterAdd: function(result) { var annotation = result.annotation; annotation.title = 'New Title'; annotation.convertToContent = true; viewer.updateAnnotation(result.pageIndex, annotation); return true; } } }); </code></pre> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5>result: { annotation: <a href="../classes/AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a>; pageIndex: number }</h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>annotation: <a href="../classes/AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a></h5></li> <li class="tsd-parameter"> <h5>pageIndex: number</h5></li></ul></li></ul></div> <h4 class="tsd-returns-title">Returns void</h4></li></ul></li></ul></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> afterShow?: ((signatureDialog: any) => void)</h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature" id="__type.__type-3.__type-4">(signatureDialog: any): void</li> <li class="tsd-description"> <div class="tsd-comment tsd-typography">The afterShow event handler will be called after the dialog is shown. <h3>Example</h3><pre><code class="language-javascript">var viewer = new DsPdfViewer("#root"); viewer.options.signTool = { afterShow: function() { alert('The dialog is shown.'); }, }; </code></pre> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5>signatureDialog: any</h5></li></ul></div> <h4 class="tsd-returns-title">Returns void</h4></li></ul></li></ul></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> autoResizeCanvas?: boolean</h5> <div class="tsd-comment tsd-typography">Automatically adjust the canvas size so that it shrinks to fit the window when the window size is small. <h3>Default</h3>true; </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> beforeAdd?: ((activeTool: any, signatureDialog: any) => boolean)</h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature" id="__type.__type-5.__type-6">(activeTool: any, signatureDialog: any): boolean</li> <li class="tsd-description"> <div class="tsd-comment tsd-typography">The beforeAdd event handler will be called when the Add button is clicked. Return false if you want to cancel default add action. <h3>Example</h3><pre><code class="language-javascript">var viewer = new DsPdfViewer("#root"); viewer.options.signTool = { beforeAdd: function() { // Put your code here. return true; }, }; </code></pre> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5>activeTool: any</h5></li> <li> <h5>signatureDialog: any</h5></li></ul></div> <h4 class="tsd-returns-title">Returns boolean</h4></li></ul></li></ul></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> beforeHide?: ((signatureDialog: any) => boolean)</h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature" id="__type.__type-7.__type-8">(signatureDialog: any): boolean</li> <li class="tsd-description"> <div class="tsd-comment tsd-typography">The beforeHide event handler will be called before the dialog is closed. Return false if you want to to prevent the dialog from closing. <h3>Example</h3><pre><code class="language-javascript">viewer.options.signTool = { subject: "subject1", beforeHide: function (dialog) { // You can execute any custom code when the dialog is about to hide: console.log("dialog subject is " + dialog.subject); } }; </code></pre> <h3>Example</h3><pre><code class="language-javascript">var viewer = new DsPdfViewer("#root"); viewer.options.signTool = { beforeHide: function() { // Return false to prevent the dialog from closing: return false; }, }; </code></pre> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5>signatureDialog: any</h5></li></ul></div> <h4 class="tsd-returns-title">Returns boolean</h4></li></ul></li></ul></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> beforeShow?: ((signatureDialog: any) => boolean)</h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature" id="__type.__type-9.__type-10">(signatureDialog: any): boolean</li> <li class="tsd-description"> <div class="tsd-comment tsd-typography">The beforeShow event handler will be called before the dialog is shown. Return false if you want to prevent the dialog from showing. <h3>Example</h3><pre><code class="language-javascript">var viewer = new DsPdfViewer("#root"); viewer.options.signTool = { beforeShow: function() { // Return false to cancel showing the dialog: return false; }, }; </code></pre> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5>signatureDialog: any</h5></li></ul></div> <h4 class="tsd-returns-title">Returns boolean</h4></li></ul></li></ul></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> bold?: boolean</h5> <div class="tsd-comment tsd-typography">Bold text style for the "Type" tab. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> canvasSize?: { height: number; width: number }</h5> <div class="tsd-comment tsd-typography">The size of the canvas in pixels. <h3>Default</h3></div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>height: number</h5></li> <li class="tsd-parameter"> <h5>width: number</h5></li></ul></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> convertToContent?: boolean</h5> <div class="tsd-comment tsd-typography">Convert the result stamp to content. <h3>Default</h3>false <h3>Example</h3><pre><code class="language-javascript">var viewer = new DsPdfViewer("#root", signTool: { convertToContent: true }); </code></pre> </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> destinationScale?: number</h5> <div class="tsd-comment tsd-typography">The target value for the canvas scale. The result annotation bounds will be scaled using this value. For example, if destinationScale is 0.5 and canvasSize is 400/200, the size of the result annotation will be 200/100. <h3>Default</h3>0.5 </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> dialogLocation?: "Center" | "Top" | "Right" | "Bottom" | "Left" | { x: number; y: number }</h5> <div class="tsd-comment tsd-typography">Dialog location within window rectangle. Origin is top/left. <h3>Default</h3>'Center' </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> fontName?: string</h5> <div class="tsd-comment tsd-typography">The default font name that will be used for the "Type" tab. <h3>Default</h3>'Brush Script MT' </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> fontNames?: string[]</h5> <div class="tsd-comment tsd-typography">Array of the available font names. <h3>Default</h3>['Arial', 'Verdana', 'Helvetica', 'Tahoma', 'Trebuchet MS', 'Times New Roman', 'Georgia', 'Garamond', 'Courier New', 'Brush Script MT'] </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> fontSize?: number</h5> <div class="tsd-comment tsd-typography">The default font size that will be used for the "Type" tab. <h3>Default</h3>48 </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> hasImage?: boolean</h5> <div class="tsd-comment tsd-typography">If true, the signature tool will try to load an image from local storage for the Image tab. <h3>Default</h3>false <h3>Example</h3><pre><code class="language-javascript">// Create the viewer: var viewer = new DsPdfViewer({ userName: 'John', signTool: { hasImage: true, saveSignature: true, selectedTab: 'Image', tabs: ['Image'] } }); // save image for use with Image tab: viewer.signToolStorage.saveImage('Image', document.querySelector('img')); </code></pre> </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> hideDialogFooter?: boolean</h5> <div class="tsd-comment tsd-typography">Specifies whether to hide dialog footer. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> hideDialogTitle?: boolean</h5> <div class="tsd-comment tsd-typography">Specifies whether to hide dialog title. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> hideSaveSignature?: boolean</h5> <div class="tsd-comment tsd-typography">Specifies whether to hide the "Save signature" button. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> hideTabs?: boolean</h5> <div class="tsd-comment tsd-typography">Specifies whether to hide tab buttons. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> hideToolbar?: boolean</h5> <div class="tsd-comment tsd-typography">Specifies whether to hide the toolbar which can be used to customize typing and drawing styles. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> italic?: boolean</h5> <div class="tsd-comment tsd-typography">Italic text style for the "Type" tab. <h3>Default</h3>true </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> location?: "Center" | "Top" | "Right" | "Bottom" | "Left" | "TopLeft" | "TopRight" | "BottomRight" | "BottomLeft" | { x: number; y: number }</h5> <div class="tsd-comment tsd-typography">The result location of the annotation on the page. Note, when you specify the exact location (using {x, y} values), the origin is at the bottom left corner. <h3>Default</h3>'BottomRight' </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> pageIndex?: number</h5> <div class="tsd-comment tsd-typography">Destination page index. <h3>Default</h3>The default is the visible page index. </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> penColor?: string</h5> <div class="tsd-comment tsd-typography">Pen color. <h3>Default</h3>#000000 <h3>Example</h3><pre><code class="language-javascript"> options.signTool = { penColor: '#00ff00' }; </code></pre> </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> penWidth?: number</h5> <div class="tsd-comment tsd-typography">Pen width. <h3>Default</h3>2 </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> ruler?: { Draw: <a href="RulerLine.html" class="tsd-signature-type" data-tsd-kind="Type alias">RulerLine</a>[] | false; Image: <a href="RulerLine.html" class="tsd-signature-type" data-tsd-kind="Type alias">RulerLine</a>[] | false; Type: <a href="RulerLine.html" class="tsd-signature-type" data-tsd-kind="Type alias">RulerLine</a>[] | false } | false</h5> <div class="tsd-comment tsd-typography">Canvas ruler lines customization. <h3>Example</h3><pre><code class="language-javascript">// Hide all ruler lines: viewer.options.signTool = { ruler: false }; </code></pre> <h3>Example</h3><pre><code class="language-javascript">// Hide the ruler for the Draw tab: viewer.options.signTool = { ruler: { Draw: false } }; </code></pre> <h3>Example</h3><pre><code class="language-javascript">// Define a custom ruler lines for the Draw tab: viewer.options.signTool = { ruler: { Draw: [{ color: "#ff0000", size: 5, type: "dashed", position: 50 }, { color: "#ff00ff", size: 2, type: "solid", position: 80 }] } }; </code></pre> </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> saveSignature?: boolean</h5> <div class="tsd-comment tsd-typography">Indicates whether the signature data must be saved into browser's local storage for later use. The saved data is owned by the active user, which can be set using the currentUserName property. <h3>Default</h3>false </div></li> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> selectedTab?: "Type" | "Draw" | "Image"</h5> <div class="tsd-comment tsd-typography">Initially selected tab. <h3>Default</h3>Default is 'Draw' <h3>Example</h3><pre><code class="language-javascript">var viewer = new<span cl