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.GetWorkerPath()
Gets the path to the Web Worker JavaScript file
|
| <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.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>
{string}
CoreControls.GetWorkerPath()
Gets the path to the Web Worker JavaScript file
- Returns:
- {string} The path to the worker
<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.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