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 '461c809e4f'
${ noResults }
cryptpad/www/common/pdfjs/api/draft/global.html

3148 lines
42 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: Global</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">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="_UnsupportedManager"><span class="type-signature"></span>_UnsupportedManager<span class="type-signature"></span></h4>
<div class="description">
(Deprecated) Global observer of unsupported feature usages. Use
onUnsupportedFeature callback of the {PDFDocumentLoadingTask} instance.
</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#line2240">line 2240</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="arrayByteLength"><span class="type-signature"></span>arrayByteLength<span class="signature">(arr)</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Gets length of the array (Array, Uint8Array, or string) in bytes.
</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>arr</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">Uint8Array</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_util.js.html">shared/util.js</a>, <a href="shared_util.js.html#line543">line 543</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="arraysToBytes"><span class="type-signature"></span>arraysToBytes<span class="signature">(arr)</span><span class="type-signature"> &rarr; {Uint8Array}</span></h4>
<div class="description">
Combines array items (arrays) into single Uint8Array object.
</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>arr</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">the array of the arrays (Array, Uint8Array, or string).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_util.js.html">shared/util.js</a>, <a href="shared_util.js.html#line556">line 556</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Uint8Array</span>
</dd>
</dl>
<h4 class="name" id="createPromiseCapability"><span class="type-signature"></span>createPromiseCapability<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#PromiseCapability">PromiseCapability</a>}</span></h4>
<div class="description">
Creates a promise capability object.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_util.js.html">shared/util.js</a>, <a href="shared_util.js.html#line1116">line 1116</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A capability object contains:
- a Promise, resolve and reject methods.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="global.html#PromiseCapability">PromiseCapability</a></span>
</dd>
</dl>
<h4 class="name" id="createValidAbsoluteUrl"><span class="type-signature"></span>createValidAbsoluteUrl<span class="signature">(url, baseUrl)</span><span class="type-signature"> &rarr; {URL}</span></h4>
<div class="description">
Attempts to create a valid absolute URL (utilizing `isValidProtocol`).
</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>url</code></td>
<td class="type">
<span class="param-type">URL</span>
|
<span class="param-type">string</span>
</td>
<td class="description last">An absolute, or relative, URL.</td>
</tr>
<tr>
<td class="name"><code>baseUrl</code></td>
<td class="type">
<span class="param-type">URL</span>
|
<span class="param-type">string</span>
</td>
<td class="description last">An absolute URL.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_util.js.html">shared/util.js</a>, <a href="shared_util.js.html#line361">line 361</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Either a valid , or `null` otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">URL</span>
</dd>
</dl>
<h4 class="name" id="getDocument"><span class="type-signature"></span>getDocument<span class="signature">(src, pdfDataRangeTransport, passwordCallback, progressCallback)</span><span class="type-signature"> &rarr; {<a href="PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a>}</span></h4>
<div class="description">
This is the main entry point for loading a PDF and interacting with it.
NOTE: If a URL is used to fetch the PDF data a standard XMLHttpRequest(XHR)
is used, which means it must follow the same origin rules that any XHR does
e.g. No cross domain requests without CORS.
</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>src</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">TypedArray</span>
|
<span class="param-type"><a href="global.html#DocumentInitParameters">DocumentInitParameters</a></span>
|
<span class="param-type"><a href="PDFDataRangeTransport.html">PDFDataRangeTransport</a></span>
</td>
<td class="description last">Can be a url to where a PDF is located, a typed array (Uint8Array)
already populated with data or parameter object.</td>
</tr>
<tr>
<td class="name"><code>pdfDataRangeTransport</code></td>
<td class="type">
<span class="param-type"><a href="PDFDataRangeTransport.html">PDFDataRangeTransport</a></span>
</td>
<td class="description last">(deprecated) It is used
if you want to manually serve range requests for data in the PDF.</td>
</tr>
<tr>
<td class="name"><code>passwordCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">(deprecated) It is used to request a
password if wrong or no password was provided. The callback receives two
parameters: function that needs to be called with new password and reason
(see {PasswordResponses}).</td>
</tr>
<tr>
<td class="name"><code>progressCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">(deprecated) It is used to be able to
monitor the loading progress of the PDF file (necessary to implement e.g.
a loading bar). The callback receives an {Object} with the properties:
{number} loaded and {number} total.</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#line167">line 167</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a></span>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="DocumentInitParameters">DocumentInitParameters</h4>
<div class="description">
Document initialization / loading parameters object.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The URL of the PDF.</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">TypedArray</span>
|
<span class="param-type">Array</span>
|
<span class="param-type">string</span>
</td>
<td class="description last">Binary PDF data. Use typed arrays
(Uint8Array) to improve the memory usage. If PDF data is BASE64-encoded,
use atob() to convert it to a binary string first.</td>
</tr>
<tr>
<td class="name"><code>httpHeaders</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Basic authentication headers.</td>
</tr>
<tr>
<td class="name"><code>withCredentials</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Indicates whether or not cross-site
Access-Control requests should be made using credentials such as cookies
or authorization headers. The default is false.</td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">For decrypting password-protected PDFs.</td>
</tr>
<tr>
<td class="name"><code>initialData</code></td>
<td class="type">
<span class="param-type">TypedArray</span>
</td>
<td class="description last">A typed array with the first portion or
all of the pdf data. Used by the extension since some data is already
loaded before the switch to range requests.</td>
</tr>
<tr>
<td class="name"><code>length</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The PDF file length. It's used for progress
reports and range requests operations.</td>
</tr>
<tr>
<td class="name"><code>range</code></td>
<td class="type">
<span class="param-type"><a href="PDFDataRangeTransport.html">PDFDataRangeTransport</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>rangeChunkSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Optional parameter to specify
maximum number of bytes fetched per range request. The default value is
2^16 = 65536.</td>
</tr>
<tr>
<td class="name"><code>worker</code></td>
<td class="type">
<span class="param-type"><a href="PDFWorker.html">PDFWorker</a></span>
</td>
<td class="description last">The worker that will be used for the loading
and parsing of the PDF data.</td>
</tr>
<tr>
<td class="name"><code>docBaseUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">(optional) The base URL of the document,
used when attempting to recover valid absolute URLs for annotations, and
outline items, that (incorrectly) only specify relative URLs.</td>
</tr>
<tr>
<td class="name"><code>disableNativeImageDecoder</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">(deprecated) Disable decoding
of certain (simple) JPEG images in the browser. This is useful for
environments without DOM image support, such as e.g. Node.js.
The default value is `false`.</td>
</tr>
<tr>
<td class="name"><code>nativeImageDecoderSupport</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">(optional) Strategy for
decoding certain (simple) JPEG images in the browser. This is useful for
environments without DOM image and canvas support, such as e.g. Node.js.
Valid values are 'decode', 'display' or 'none'; where 'decode' is intended
for browsers with full image/canvas support, 'display' for environments
with limited image support through stubs (useful for SVG conversion),
and 'none' where JPEG images will be decoded entirely by PDF.js.
The default value is 'decode'.</td>
</tr>
<tr>
<td class="name"><code>CMapReaderFactory</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">(optional) The factory that will be
used when reading built-in CMap files. Providing a custom factory is useful
for environments without `XMLHttpRequest` support, such as e.g. Node.js.
The default value is {DOMCMapReaderFactory}.</td>
</tr>
<tr>
<td class="name"><code>stopAtErrors</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">(optional) Reject certain promises, e.g.
`getOperatorList`, `getTextContent`, and `RenderTask`, when the associated
PDF data cannot be successfully parsed, instead of attempting to recover
whatever possible of the data. The default value is `false`.</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#line85">line 85</a>
</li></ul></dd>
</dl>
<h4 class="name" id="GetAnnotationsParameters">GetAnnotationsParameters</h4>
<div class="description">
Page annotation parameters.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>intent</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Determines the annotations that will be fetched,
can be either 'display' (viewable annotations) or 'print'
(printable annotations).
If the parameter is omitted, all annotations are fetched.</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#line687">line 687</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getTextContentParameters">getTextContentParameters</h4>
<div class="description">
Page getTextContent parameters.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>normalizeWhitespace</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">replaces all occurrences of
whitespace with standard spaces (0x20). The default value is `false`.</td>
</tr>
<tr>
<td class="name"><code>disableCombineTextItems</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">do not attempt to combine
same line <a href="global.html#TextItem">TextItem</a>'s. The default value is `false`.</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#line647">line 647</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PDFDocumentStats">PDFDocumentStats</h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>streamTypes</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Used stream types in the document (an item
is set to true if specific stream ID was used in the document).</td>
</tr>
<tr>
<td class="name"><code>fontTypes</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Used font type in the document (an item is set
to true if specific font ID was used in the document).</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#line134">line 134</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PDFOperatorList">PDFOperatorList</h4>
<div class="description">
PDF page operator list.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fnArray</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Array containing the operator functions.</td>
</tr>
<tr>
<td class="name"><code>argsArray</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Array containing the arguments of the
functions.</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#line727">line 727</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PromiseCapability">PromiseCapability</h4>
<div class="description">
Promise Capability object.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>promise</code></td>
<td class="type">
<span class="param-type">Promise</span>
</td>
<td class="description last">A promise object.</td>
</tr>
<tr>
<td class="name"><code>resolve</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Fulfills the promise.</td>
</tr>
<tr>
<td class="name"><code>reject</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Rejects the promise.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_util.js.html">shared/util.js</a>, <a href="shared_util.js.html#line1100">line 1100</a>
</li></ul></dd>
</dl>
<h4 class="name" id="RenderParameters">RenderParameters</h4>
<div class="description">
Page render parameters.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>canvasContext</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A 2D context of a DOM Canvas object.</td>
</tr>
<tr>
<td class="name"><code>viewport</code></td>
<td class="type">
<span class="param-type"><a href="PageViewport.html">PageViewport</a></span>
</td>
<td class="description last">Rendering viewport obtained by
calling of PDFPage.getViewport method.</td>
</tr>
<tr>
<td class="name"><code>intent</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Rendering intent, can be 'display' or 'print'
(default value is 'display').</td>
</tr>
<tr>
<td class="name"><code>renderInteractiveForms</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">(optional) Whether or not
interactive form elements are rendered in the display
layer. If so, we do not render them on canvas as well.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">(optional) Additional transform, applied
just before viewport transform.</td>
</tr>
<tr>
<td class="name"><code>imageLayer</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">(optional) An object that has beginLayout,
endLayout and appendImage functions.</td>
</tr>
<tr>
<td class="name"><code>continueCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">(deprecated) A function that will be
called each time the rendering is paused. To continue
rendering call the function that is the first argument
to the callback.</td>
</tr>
<tr>
<td class="name"><code>canvasFactory</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">(optional) The factory that will be used
when creating canvases. The default value is
{DOMCanvasFactory}.</td>
</tr>
<tr>
<td class="name"><code>background</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">(optional) Background to use for the canvas.
Can use any valid canvas.fillStyle: A DOMString parsed as
CSS <color> value, a CanvasGradient object (a linear or
radial gradient) or a CanvasPattern object (a repetitive
image). The default value is 'rgb(255,255,255)'.</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#line697">line 697</a>
</li></ul></dd>
</dl>
<h4 class="name" id="TextContent">TextContent</h4>
<div class="description">
Page text content.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">array of <a href="global.html#TextItem">TextItem</a></td>
</tr>
<tr>
<td class="name"><code>styles</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">TextStyles objects, indexed by font name.</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#line657">line 657</a>
</li></ul></dd>
</dl>
<h4 class="name" id="TextItem">TextItem</h4>
<div class="description">
Page text content part.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>str</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">text content.</td>
</tr>
<tr>
<td class="name"><code>dir</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">text direction: 'ttb', 'ltr' or 'rtl'.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">transformation matrix.</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">width in device space.</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">height in device space.</td>
</tr>
<tr>
<td class="name"><code>fontName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">font name used by pdf.js for converted font.</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#line665">line 665</a>
</li></ul></dd>
</dl>
<h4 class="name" id="TextStyle">TextStyle</h4>
<div class="description">
Text style.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ascent</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">font ascent.</td>
</tr>
<tr>
<td class="name"><code>descent</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">font descent.</td>
</tr>
<tr>
<td class="name"><code>vertical</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">text is in vertical mode.</td>
</tr>
<tr>
<td class="name"><code>fontFamily</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">possible font family</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#line677">line 677</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>