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.
362 lines
12 KiB
HTML
362 lines
12 KiB
HTML
7 years ago
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>JSDoc: Source: display/global.js</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">Source: display/global.js</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article>
|
||
|
|
<pre class="prettyprint source linenums"><code>/* Copyright 2015 Mozilla Foundation
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
import {
|
||
|
|
_UnsupportedManager, getDocument, LoopbackPort, PDFDataRangeTransport,
|
||
|
|
PDFWorker
|
||
|
|
} from './api';
|
||
|
|
import {
|
||
|
|
addLinkAttributes, CustomStyle, DEFAULT_LINK_REL, getFilenameFromUrl,
|
||
|
|
isExternalLinkTargetSet, isValidUrl, LinkTarget
|
||
|
|
} from './dom_utils';
|
||
|
|
import {
|
||
|
|
createBlob, createObjectURL, createPromiseCapability, deprecated,
|
||
|
|
getVerbosityLevel, globalScope, InvalidPDFException, isLittleEndian,
|
||
|
|
MissingPDFException, OPS, PageViewport, PasswordException, PasswordResponses,
|
||
|
|
removeNullCharacters, setVerbosityLevel, shadow, UnexpectedResponseException,
|
||
|
|
UnknownErrorException, UNSUPPORTED_FEATURES, Util, VERBOSITY_LEVELS, warn
|
||
|
|
} from '../shared/util';
|
||
|
|
import { AnnotationLayer } from './annotation_layer';
|
||
|
|
import { Metadata } from './metadata';
|
||
|
|
import { renderTextLayer } from './text_layer';
|
||
|
|
import { SVGGraphics } from './svg';
|
||
|
|
|
||
|
|
var isWorker = (typeof window === 'undefined');
|
||
|
|
|
||
|
|
// The global PDFJS object is now deprecated and will not be supported in
|
||
|
|
// the future. The members below are maintained for backward compatibility
|
||
|
|
// and shall not be extended or modified. If the global.js is included as
|
||
|
|
// a module, we will create a global PDFJS object instance or use existing.
|
||
|
|
if (!globalScope.PDFJS) {
|
||
|
|
globalScope.PDFJS = {};
|
||
|
|
}
|
||
|
|
var PDFJS = globalScope.PDFJS;
|
||
|
|
|
||
|
|
if (typeof PDFJSDev !== 'undefined') {
|
||
|
|
PDFJS.version = PDFJSDev.eval('BUNDLE_VERSION');
|
||
|
|
PDFJS.build = PDFJSDev.eval('BUNDLE_BUILD');
|
||
|
|
}
|
||
|
|
|
||
|
|
PDFJS.pdfBug = false;
|
||
|
|
|
||
|
|
if (PDFJS.verbosity !== undefined) {
|
||
|
|
setVerbosityLevel(PDFJS.verbosity);
|
||
|
|
}
|
||
|
|
delete PDFJS.verbosity;
|
||
|
|
Object.defineProperty(PDFJS, 'verbosity', {
|
||
|
|
get() {
|
||
|
|
return getVerbosityLevel();
|
||
|
|
},
|
||
|
|
set(level) {
|
||
|
|
setVerbosityLevel(level);
|
||
|
|
},
|
||
|
|
enumerable: true,
|
||
|
|
configurable: true,
|
||
|
|
});
|
||
|
|
|
||
|
|
PDFJS.VERBOSITY_LEVELS = VERBOSITY_LEVELS;
|
||
|
|
PDFJS.OPS = OPS;
|
||
|
|
PDFJS.UNSUPPORTED_FEATURES = UNSUPPORTED_FEATURES;
|
||
|
|
PDFJS.isValidUrl = isValidUrl;
|
||
|
|
PDFJS.shadow = shadow;
|
||
|
|
PDFJS.createBlob = createBlob;
|
||
|
|
PDFJS.createObjectURL = function PDFJS_createObjectURL(data, contentType) {
|
||
|
|
return createObjectURL(data, contentType, PDFJS.disableCreateObjectURL);
|
||
|
|
};
|
||
|
|
Object.defineProperty(PDFJS, 'isLittleEndian', {
|
||
|
|
configurable: true,
|
||
|
|
get: function PDFJS_isLittleEndian() {
|
||
|
|
return shadow(PDFJS, 'isLittleEndian', isLittleEndian());
|
||
|
|
},
|
||
|
|
});
|
||
|
|
PDFJS.removeNullCharacters = removeNullCharacters;
|
||
|
|
PDFJS.PasswordResponses = PasswordResponses;
|
||
|
|
PDFJS.PasswordException = PasswordException;
|
||
|
|
PDFJS.UnknownErrorException = UnknownErrorException;
|
||
|
|
PDFJS.InvalidPDFException = InvalidPDFException;
|
||
|
|
PDFJS.MissingPDFException = MissingPDFException;
|
||
|
|
PDFJS.UnexpectedResponseException = UnexpectedResponseException;
|
||
|
|
PDFJS.Util = Util;
|
||
|
|
PDFJS.PageViewport = PageViewport;
|
||
|
|
PDFJS.createPromiseCapability = createPromiseCapability;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* @var {number}
|
||
|
|
*/
|
||
|
|
PDFJS.maxImageSize = (PDFJS.maxImageSize === undefined ?
|
||
|
|
-1 : PDFJS.maxImageSize);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The url of where the predefined Adobe CMaps are located. Include trailing
|
||
|
|
* slash.
|
||
|
|
* @var {string}
|
||
|
|
*/
|
||
|
|
PDFJS.cMapUrl = (PDFJS.cMapUrl === undefined ? null : PDFJS.cMapUrl);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Specifies if CMaps are binary packed.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.cMapPacked = PDFJS.cMapPacked === undefined ? false : PDFJS.cMapPacked;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableFontFace = (PDFJS.disableFontFace === undefined ?
|
||
|
|
false : PDFJS.disableFontFace);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Path for image resources, mainly for annotation icons. Include trailing
|
||
|
|
* slash.
|
||
|
|
* @var {string}
|
||
|
|
*/
|
||
|
|
PDFJS.imageResourcesPath = (PDFJS.imageResourcesPath === undefined ?
|
||
|
|
'' : PDFJS.imageResourcesPath);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableWorker = (PDFJS.disableWorker === undefined ?
|
||
|
|
false : PDFJS.disableWorker);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* @var {string}
|
||
|
|
*/
|
||
|
|
PDFJS.workerSrc = (PDFJS.workerSrc === undefined ? null : PDFJS.workerSrc);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Defines global port for worker process. Overrides workerSrc and
|
||
|
|
* disableWorker setting.
|
||
|
|
*/
|
||
|
|
PDFJS.workerPort = (PDFJS.workerPort === undefined ? null : PDFJS.workerPort);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableRange = (PDFJS.disableRange === undefined ?
|
||
|
|
false : PDFJS.disableRange);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Disable streaming of PDF file data. By default PDF.js attempts to load PDF
|
||
|
|
* in chunks. This default behavior can be disabled.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableStream = (PDFJS.disableStream === undefined ?
|
||
|
|
false : PDFJS.disableStream);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableAutoFetch = (PDFJS.disableAutoFetch === undefined ?
|
||
|
|
false : PDFJS.disableAutoFetch);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enables special hooks for debugging PDF.js.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.pdfBug = (PDFJS.pdfBug === undefined ? false : PDFJS.pdfBug);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enables transfer usage in postMessage for ArrayBuffers.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.postMessageTransfers = (PDFJS.postMessageTransfers === undefined ?
|
||
|
|
true : PDFJS.postMessageTransfers);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Disables URL.createObjectURL usage.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableCreateObjectURL = (PDFJS.disableCreateObjectURL === undefined ?
|
||
|
|
false : PDFJS.disableCreateObjectURL);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Disables WebGL usage.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.disableWebGL = (PDFJS.disableWebGL === undefined ?
|
||
|
|
true : PDFJS.disableWebGL);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Specifies the |target| attribute for external links.
|
||
|
|
* The constants from PDFJS.LinkTarget should be used:
|
||
|
|
* - NONE [default]
|
||
|
|
* - SELF
|
||
|
|
* - BLANK
|
||
|
|
* - PARENT
|
||
|
|
* - TOP
|
||
|
|
* @var {number}
|
||
|
|
*/
|
||
|
|
PDFJS.externalLinkTarget = (PDFJS.externalLinkTarget === undefined ?
|
||
|
|
LinkTarget.NONE : PDFJS.externalLinkTarget);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Specifies the |rel| attribute for external links. Defaults to stripping
|
||
|
|
* the referrer.
|
||
|
|
* @var {string}
|
||
|
|
*/
|
||
|
|
PDFJS.externalLinkRel = (PDFJS.externalLinkRel === undefined ?
|
||
|
|
DEFAULT_LINK_REL : PDFJS.externalLinkRel);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Determines if we can eval strings as JS. Primarily used to improve
|
||
|
|
* performance for font rendering.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.isEvalSupported = (PDFJS.isEvalSupported === undefined ?
|
||
|
|
true : PDFJS.isEvalSupported);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Opt-in to backwards incompatible API changes. NOTE:
|
||
|
|
* If the `PDFJS_NEXT` build flag is set, it will override this setting.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.pdfjsNext = (PDFJS.pdfjsNext === undefined) ? false : PDFJS.pdfjsNext;
|
||
|
|
|
||
|
|
if (typeof PDFJSDev === 'undefined' || !PDFJSDev.test('MOZCENTRAL')) {
|
||
|
|
var savedOpenExternalLinksInNewWindow = PDFJS.openExternalLinksInNewWindow;
|
||
|
|
delete PDFJS.openExternalLinksInNewWindow;
|
||
|
|
Object.defineProperty(PDFJS, 'openExternalLinksInNewWindow', {
|
||
|
|
get() {
|
||
|
|
return PDFJS.externalLinkTarget === LinkTarget.BLANK;
|
||
|
|
},
|
||
|
|
set(value) {
|
||
|
|
if (value) {
|
||
|
|
deprecated('PDFJS.openExternalLinksInNewWindow, please use ' +
|
||
|
|
'"PDFJS.externalLinkTarget = PDFJS.LinkTarget.BLANK" instead.');
|
||
|
|
}
|
||
|
|
if (PDFJS.externalLinkTarget !== LinkTarget.NONE) {
|
||
|
|
warn('PDFJS.externalLinkTarget is already initialized');
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
PDFJS.externalLinkTarget = value ? LinkTarget.BLANK : LinkTarget.NONE;
|
||
|
|
},
|
||
|
|
enumerable: true,
|
||
|
|
configurable: true,
|
||
|
|
});
|
||
|
|
if (savedOpenExternalLinksInNewWindow) {
|
||
|
|
/**
|
||
|
|
* (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.
|
||
|
|
* @var {boolean}
|
||
|
|
*/
|
||
|
|
PDFJS.openExternalLinksInNewWindow = savedOpenExternalLinksInNewWindow;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
PDFJS.getDocument = getDocument;
|
||
|
|
PDFJS.LoopbackPort = LoopbackPort;
|
||
|
|
PDFJS.PDFDataRangeTransport = PDFDataRangeTransport;
|
||
|
|
PDFJS.PDFWorker = PDFWorker;
|
||
|
|
|
||
|
|
PDFJS.hasCanvasTypedArrays = true; // compatibility.js ensures this invariant
|
||
|
|
PDFJS.CustomStyle = CustomStyle;
|
||
|
|
PDFJS.LinkTarget = LinkTarget;
|
||
|
|
PDFJS.addLinkAttributes = addLinkAttributes;
|
||
|
|
PDFJS.getFilenameFromUrl = getFilenameFromUrl;
|
||
|
|
PDFJS.isExternalLinkTargetSet = isExternalLinkTargetSet;
|
||
|
|
|
||
|
|
PDFJS.AnnotationLayer = AnnotationLayer;
|
||
|
|
|
||
|
|
PDFJS.renderTextLayer = renderTextLayer;
|
||
|
|
|
||
|
|
PDFJS.Metadata = Metadata;
|
||
|
|
|
||
|
|
PDFJS.SVGGraphics = SVGGraphics;
|
||
|
|
|
||
|
|
PDFJS.UnsupportedManager = _UnsupportedManager;
|
||
|
|
|
||
|
|
export {
|
||
|
|
globalScope,
|
||
|
|
isWorker,
|
||
|
|
PDFJS,
|
||
|
|
};
|
||
|
|
</code></pre>
|
||
|
|
</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>
|