cryptpad/www/common/pdfjs/api/draft/AnnotationBorderStyle.html

828 lines
9.5 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: AnnotationBorderStyle</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: AnnotationBorderStyle</h1>
<section>
<header>
<h2>AnnotationBorderStyle</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="AnnotationBorderStyle"><span class="type-signature"></span>new AnnotationBorderStyle<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Contains all data regarding an annotation's border style.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_annotation.js.html">core/annotation.js</a>, <a href="core_annotation.js.html#line449">line 449</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".setDashArray"><span class="type-signature">(static) </span>setDashArray<span class="signature">(dashArray)</span><span class="type-signature"></span></h4>
<div class="description">
Set the dash array.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dashArray</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">The dash array with at least one element</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_annotation.js.html">core/annotation.js</a>, <a href="core_annotation.js.html#line521">line 521</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".setHorizontalCornerRadius"><span class="type-signature">(static) </span>setHorizontalCornerRadius<span class="signature">(radius)</span><span class="type-signature"></span></h4>
<div class="description">
Set the horizontal corner radius (from a Border dictionary).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>radius</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last">The horizontal corner radius</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_annotation.js.html">core/annotation.js</a>, <a href="core_annotation.js.html#line557">line 557</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".setStyle"><span class="type-signature">(static) </span>setStyle<span class="signature">(style)</span><span class="type-signature"></span></h4>
<div class="description">
Set the style.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">The style object</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_annotation.js.html">core/annotation.js</a>, <a href="core_annotation.js.html#line484">line 484</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="shared_util.js.html">shared/util.js</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".setVerticalCornerRadius"><span class="type-signature">(static) </span>setVerticalCornerRadius<span class="signature">(radius)</span><span class="type-signature"></span></h4>
<div class="description">
Set the vertical corner radius (from a Border dictionary).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>radius</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last">The vertical corner radius</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_annotation.js.html">core/annotation.js</a>, <a href="core_annotation.js.html#line571">line 571</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".setWidth"><span class="type-signature">(static) </span>setWidth<span class="signature">(width)</span><span class="type-signature"></span></h4>
<div class="description">
Set the width.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last">The width</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_annotation.js.html">core/annotation.js</a>, <a href="core_annotation.js.html#line470">line 470</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AnnotationBorderStyle.html">AnnotationBorderStyle</a></li><li><a href="AnnotationFactory.html">AnnotationFactory</a></li><li><a href="PageViewport.html">PageViewport</a></li><li><a href="PDFDataRangeTransport.html">PDFDataRangeTransport</a></li><li><a href="PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a></li><li><a href="PDFDocumentProxy.html">PDFDocumentProxy</a></li><li><a href="PDFJS.html">PDFJS</a></li><li><a href="PDFPageProxy.html">PDFPageProxy</a></li><li><a href="PDFWorker.html">PDFWorker</a></li><li><a href="RenderTask.html">RenderTask</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_UnsupportedManager">_UnsupportedManager</a></li><li><a href="global.html#arrayByteLength">arrayByteLength</a></li><li><a href="global.html#arraysToBytes">arraysToBytes</a></li><li><a href="global.html#createPromiseCapability">createPromiseCapability</a></li><li><a href="global.html#createValidAbsoluteUrl">createValidAbsoluteUrl</a></li><li><a href="global.html#getDocument">getDocument</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 12 2017 08:43:32 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>