infra
/
cryptpad
2
1
Fork 0
Code Issues Pull Requests Projects Releases 1 Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
v4.14.0
v4.14.1
v5.0.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '72a855aa6a'
${ noResults }
cryptpad/www/common/pdfjs/api/draft/PDFJS.html

1706 lines
20 KiB
HTML
Raw Normal View History Unescape Escape

Modifications for latest media-tag * use latest built media-tag * include pdfjs and configure its path for media-tag * check whether decryption events affect an avatar. crop it if so
7 years ago
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: PDFJS</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: PDFJS</h1>
<section>
<header>
<h2>PDFJS</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="PDFJS"><span class="type-signature"></span>new PDFJS<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
PDFJS scope object that contains all functions, objects and variables related
to the PDF.js.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="doc_helper.js.html">doc_helper.js</a>, <a href="doc_helper.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".cMapPacked"><span class="type-signature">(static) </span>cMapPacked<span class="type-signature"> :boolean</span></h4>
<div class="description">
Specifies if CMaps are binary packed.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line114">line 114</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".cMapUrl"><span class="type-signature">(static) </span>cMapUrl<span class="type-signature"> :string</span></h4>
<div class="description">
The url of where the predefined Adobe CMaps are located. Include trailing
slash.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line108">line 108</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableAutoFetch"><span class="type-signature">(static) </span>disableAutoFetch<span class="type-signature"> :boolean</span></h4>
<div class="description">
Disable pre-fetching of PDF file data. When range requests are enabled
PDF.js will automatically keep fetching more data even if it isn't needed
to display the current page. This default behavior can be disabled.
NOTE: It is also necessary to disable streaming, see above,
in order for disabling of pre-fetching to work correctly.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line184">line 184</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableCreateObjectURL"><span class="type-signature">(static) </span>disableCreateObjectURL<span class="type-signature"> :boolean</span></h4>
<div class="description">
Disables URL.createObjectURL usage.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line204">line 204</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableFontFace"><span class="type-signature">(static) </span>disableFontFace<span class="type-signature"> :boolean</span></h4>
<div class="description">
By default fonts are converted to OpenType fonts and loaded via font face
rules. If disabled, the font will be rendered using a built in font
renderer that constructs the glyphs with primitive path commands.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableRange"><span class="type-signature">(static) </span>disableRange<span class="type-signature"> :boolean</span></h4>
<div class="description">
Disable range request loading of PDF files. When enabled and if the server
supports partial content requests then the PDF will be fetched in chunks.
Enabled (false) by default.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line164">line 164</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableStream"><span class="type-signature">(static) </span>disableStream<span class="type-signature"> :boolean</span></h4>
<div class="description">
Disable streaming of PDF file data. By default PDF.js attempts to load PDF
in chunks. This default behavior can be disabled.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line172">line 172</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableWebGL"><span class="type-signature">(static) </span>disableWebGL<span class="type-signature"> :boolean</span></h4>
<div class="description">
Disables WebGL usage.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line211">line 211</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".disableWorker"><span class="type-signature">(static) </span>disableWorker<span class="type-signature"> :boolean</span></h4>
<div class="description">
Disable the web worker and run all code on the main thread. This will
happen automatically if the browser doesn't support workers or sending
typed arrays to workers.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".externalLinkRel"><span class="type-signature">(static) </span>externalLinkRel<span class="type-signature"> :string</span></h4>
<div class="description">
Specifies the |rel| attribute for external links. Defaults to stripping
the referrer.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line232">line 232</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".externalLinkTarget"><span class="type-signature">(static) </span>externalLinkTarget<span class="type-signature"> :number</span></h4>
<div class="description">
Specifies the |target| attribute for external links.
The constants from PDFJS.LinkTarget should be used:
- NONE [default]
- SELF
- BLANK
- PARENT
- TOP
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line224">line 224</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".imageResourcesPath"><span class="type-signature">(static) </span>imageResourcesPath<span class="type-signature"> :string</span></h4>
<div class="description">
Path for image resources, mainly for annotation icons. Include trailing
slash.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line130">line 130</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".isEvalSupported"><span class="type-signature">(static) </span>isEvalSupported<span class="type-signature"> :boolean</span></h4>
<div class="description">
Determines if we can eval strings as JS. Primarily used to improve
performance for font rendering.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line240">line 240</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".maxImageSize"><span class="type-signature">(static) </span>maxImageSize<span class="type-signature"> :number</span></h4>
<div class="description">
The maximum allowed image size in total pixels e.g. width * height. Images
above this value will not be drawn. Use -1 for no limit.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line100">line 100</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".openExternalLinksInNewWindow"><span class="type-signature">(static) </span>openExternalLinksInNewWindow<span class="type-signature"> :boolean</span></h4>
<div class="description">
(Deprecated) Opens external links in a new window if enabled.
The default behavior opens external links in the PDF.js window.
NOTE: This property has been deprecated, please use
`PDFJS.externalLinkTarget = PDFJS.LinkTarget.BLANK` instead.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line280">line 280</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".pdfBug"><span class="type-signature">(static) </span>pdfBug<span class="type-signature"> :boolean</span></h4>
<div class="description">
Enables special hooks for debugging PDF.js.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line191">line 191</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".pdfjsNext"><span class="type-signature">(static) </span>pdfjsNext<span class="type-signature"> :boolean</span></h4>
<div class="description">
Opt-in to backwards incompatible API changes. NOTE:
If the `PDFJS_NEXT` build flag is set, it will override this setting.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line248">line 248</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".postMessageTransfers"><span class="type-signature">(static) </span>postMessageTransfers<span class="type-signature"> :boolean</span></h4>
<div class="description">
Enables transfer usage in postMessage for ArrayBuffers.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line197">line 197</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".verbosity"><span class="type-signature">(static) </span>verbosity<span class="type-signature"> :number</span></h4>
<div class="description">
Controls the logging level.
The constants from PDFJS.VERBOSITY_LEVELS should be used:
- errors
- warnings [default]
- infos
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="doc_helper.js.html">doc_helper.js</a>, <a href="doc_helper.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".workerPort"><span class="type-signature">(static) </span>workerPort<span class="type-signature"></span></h4>
<div class="description">
Defines global port for worker process. Overrides workerSrc and
disableWorker setting.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line156">line 156</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".workerSrc"><span class="type-signature">(static) </span>workerSrc<span class="type-signature"> :string</span></h4>
<div class="description">
Path and filename of the worker file. Required when the worker is enabled
in development mode. If unspecified in the production build, the worker
will be loaded based on the location of the pdf.js file. It is recommended
that the workerSrc is set in a custom application to prevent issues caused
by third-party frameworks and libraries.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="display_global.js.html">display/global.js</a>, <a href="display_global.js.html#line150">line 150</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>