<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: PDFPageProxy</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: PDFPageProxy</h1> <section> <header> <h2>PDFPageProxy</h2> </header> <article> <div class="container-overview"> <h4 class="name" id="PDFPageProxy"><span class="type-signature"></span>new PDFPageProxy<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Proxy to a PDFPage in the worker thread. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line741">line 741</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="pageNumber"><span class="type-signature"></span>pageNumber<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line759">line 759</a> </li></ul></dd> </dl> <h4 class="name" id="ref"><span class="type-signature"></span>ref<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line772">line 772</a> </li></ul></dd> </dl> <h4 class="name" id="rotate"><span class="type-signature"></span>rotate<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line765">line 765</a> </li></ul></dd> </dl> <h4 class="name" id="userUnit"><span class="type-signature"></span>userUnit<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line778">line 778</a> </li></ul></dd> </dl> <h4 class="name" id="view"><span class="type-signature"></span>view<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line785">line 785</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="_destroy"><span class="type-signature"></span>_destroy<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Destroys page object. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line970">line 970</a> </li></ul></dd> </dl> <h4 class="name" id="cleanup"><span class="type-signature"></span>cleanup<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Cleans up resources allocated by the page. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line1005">line 1005</a> </li></ul></dd> </dl> <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Cleans up resources allocated by the page. (deprecated) </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line997">line 997</a> </li></ul></dd> </dl> <h4 class="name" id="getAnnotations"><span class="type-signature"></span>getAnnotations<span class="signature">(params)</span><span class="type-signature"> → {Promise}</span></h4> <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>params</code></td> <td class="type"> <span class="param-type"><a href="global.html#GetAnnotationsParameters">GetAnnotationsParameters</a></span> </td> <td class="description last">Annotation parameters.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line806">line 806</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> A promise that is resolved with an {Array} of the annotation objects. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="getOperatorList"><span class="type-signature"></span>getOperatorList<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line913">line 913</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> A promise resolved with an <a href="global.html#PDFOperatorList">PDFOperatorList</a> object that represents page's operator list. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="getTextContent"><span class="type-signature"></span>getTextContent<span class="signature">(params)</span><span class="type-signature"> → {Promise}</span></h4> <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>params</code></td> <td class="type"> <span class="param-type"><a href="global.html#getTextContentParameters">getTextContentParameters</a></span> </td> <td class="description last">getTextContent parameters.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line958">line 958</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> That is resolved a <a href="global.html#TextContent">TextContent</a> object that represent the page text content. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise</span> </dd> </dl> <h4 class="name" id="getViewport"><span class="type-signature"></span>getViewport<span class="signature">(scale, rotate)</span><span class="type-signature"> → {<a href="PageViewport.html">PageViewport</a>}</span></h4> <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>scale</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">The desired scale of the viewport.</td> </tr> <tr> <td class="name"><code>rotate</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">Degrees to rotate the viewport. If omitted this defaults to the page rotation.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line795">line 795</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Contains 'width' and 'height' properties along with transforms required for rendering. </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="PageViewport.html">PageViewport</a></span> </dd> </dl> <h4 class="name" id="render"><span class="type-signature"></span>render<span class="signature">(params)</span><span class="type-signature"> → {<a href="RenderTask.html">RenderTask</a>}</span></h4> <div class="description"> Begins the process of rendering a page to the desired context. </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>params</code></td> <td class="type"> <span class="param-type"><a href="global.html#RenderParameters">RenderParameters</a></span> </td> <td class="description last">Page render parameters.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="display_api.js.html">display/api.js</a>, <a href="display_api.js.html#line822">line 822</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> An object that contains the promise, which is resolved when the page finishes rendering. </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="RenderTask.html">RenderTask</a></span> </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>