Namespace CoreControls
The namespace containing WebViewer's core user controls.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Contains the core DocumentViewer control and the Document class.
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
CoreControls.CanvasMode
Canvas mode enumeration, has values of PageCanvas (default) and ViewportCanvas
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
CoreControls.BaseDocument()
BaseDocument is used to alert if a Document implementation is not following the Document interface.
|
| <static> |
CoreControls.getCurrentBackendType()
Gets the current backend type being used.
|
| <static> |
CoreControls.getDefaultPdfBackendType()
Gets the default pdf backend type that should be used for this browser.
|
| <static> |
CoreControls.getWorkerPath()
Gets the path to the Web Worker JavaScript file
|
| <static> |
CoreControls.initPDFWorkerTransports(pdfBackendType, workerHandlers, l)
Begins setup of PDF Worker Object.
|
| <static> |
CoreControls.preloadPDFWorker(pdfBackendType, workerHandlers, options)
Begins setup of PDF Worker Object.
|
| <static> |
CoreControls.setAdvancedImageScaling(advanced)
Forces a higher level of accuracy in image downsampling at the expense of rendering performance.
|
| <static> |
CoreControls.SetCachingLevel(level)
Set the caching level between 0 and 10, where 0 is no caching and 10 uses a very large cache
|
| <static> |
CoreControls.SetCanvasMode(mode)
Sets the canvas rendering mode.
|
| <static> |
CoreControls.SetPreRenderLevel(level)
Set the pre-render level between 0 and 10, where 0 has pre-rendering and 10 has a lot of pre-rendering.
|
| <static> |
CoreControls.setProgressiveTime(milliseconds)
Control the time between progressive events when rendering a more complex page.
|
| <static> |
CoreControls.setWorkerPath(path)
Sets the path to the Web Worker JavaScript file.
|
Field Detail
<static>
CoreControls.CanvasMode
Canvas mode enumeration, has values of PageCanvas (default) and ViewportCanvas
Method Detail
<static>
CoreControls.BaseDocument()
BaseDocument is used to alert if a Document implementation is not following the Document interface.
<static>
{string}
CoreControls.getCurrentBackendType()
Gets the current backend type being used.
- Returns:
- {string} Returns "pnacl" is PNaCl is being used, "ems" if Emscripten is being used and undefined if nothing is being used yet
<static>
{string}
CoreControls.getDefaultPdfBackendType()
Gets the default pdf backend type that should be used for this browser.
- Returns:
- {string} Returns "pnacl" is PNaCl should be used and "ems" if Emscripten should be used
<static>
{string}
CoreControls.getWorkerPath()
Gets the path to the Web Worker JavaScript file
- Returns:
- {string} The path to the worker
<static>
CoreControls.initPDFWorkerTransports(pdfBackendType, workerHandlers, l)
Begins setup of PDF Worker Object.
- Parameters:
- {string} pdfBackendType
- object representing an PDF backend type ("pnacl" or "ems")
- {object} workerHandlers
- object holding event and error handlers for the worker (workerLoadingProgress, pnaclCrashError, pnaclLoadError, emsWorkerError).
- {string} l
- The license key to use for this worker. If undefined PDFNet will be initialized in demo mode.
- Returns:
- a promise that will be resolved when worker transport initialization is complete.
<static>
{object}
CoreControls.preloadPDFWorker(pdfBackendType, workerHandlers, options)
Begins setup of PDF Worker Object. This can be used to load the workers before a license key has been loaded.
- Parameters:
- {string} pdfBackendType
- object representing an PDF backend type ("pnacl" or "ems")
- {object} workerHandlers
- object holding event and error handlers for the worker (workerLoadingProgress).
- {object} options
- An object with the following optional values: useEmscriptenWhileLoading If the backend type is set to pnacl then this determines whether emscripten should be used if PNaCl needs time to set up. autoSwap Whether PNaCl should automatically be swapped to when it finishes loading
- Returns:
- {object} The worker object
<static>
CoreControls.setAdvancedImageScaling(advanced)
Forces a higher level of accuracy in image downsampling at the expense of rendering performance.
This function should be called before loading a document to ensure this setting is used.
- Parameters:
- {bool} advanced
- if true advanced image scaling will be used
<static>
CoreControls.SetCachingLevel(level)
Set the caching level between 0 and 10, where 0 is no caching and 10 uses a very large cache
- Parameters:
- {number} level
- The level to set
<static>
CoreControls.SetCanvasMode(mode)
Sets the canvas rendering mode.
- Parameters:
- {CoreControls.CanvasMode} mode
- The canvas mode to switch to
<static>
CoreControls.SetPreRenderLevel(level)
Set the pre-render level between 0 and 10, where 0 has pre-rendering and 10 has a lot of pre-rendering.
- Parameters:
- {number} level
- The level to set
<static>
CoreControls.setProgressiveTime(milliseconds)
Control the time between progressive events when rendering a more complex page.
- Parameters:
- {number} milliseconds
- the number of milliseconds between progressive events. This is 1000 by default.
<static>
CoreControls.setWorkerPath(path)
Sets the path to the Web Worker JavaScript file.
By default the file is expected to be in the same directory as the html file of the viewer
and the path should be specified relative to the html file
- Parameters:
- {string} path
- Path to the Web Worker JS file relative to the html file of the viewer