Namespace PDFNet
Contains PDFNetJS classes and functions
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
[INSERT DESCRIPTION HERE]
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.beginOperation(optionsObj)
beginOperation locks all Emscripten worker operations on PDFNet so as to avoid
potential editing conflicts.
|
| <static> |
PDFNet.deallocateAllObjects()
Removes all PDFNetJS objects from memory.
|
| <static> |
PDFNet.displayAllocatedObjects()
Displays in the console a list of objects still in memory in the form of their type and ID.
|
| <static> |
PDFNet.enableJavaScript(enable)
A switch that can be used to turn on/off JavaScript engine
|
| <static> |
PDFNet.endDeallocateStack()
Deallocates all objects in memory that were created after the most recent startDeallocateStack call.
|
| <static> |
PDFNet.finishOperation()
finishOperation releases the lock on all Emscripten worker operations on PDFNet.
|
| <static> |
PDFNet.getNormalizedUrl(url)
[Documentation Not Yet Added]
|
| <static> |
PDFNet.getStackCount()
Gets the number of PDFNet.startDeallocateStack() calls made that have not yet been ended.
|
| <static> |
PDFNet.getVersion()
|
| <static> |
PDFNet.isJavaScriptEnabled()
Test whether JavaScript is enabled
|
| <static> |
PDFNet.runGeneratorWithCleanup(generator, license_key)
This function is a utility method which will initialize PDFNet, begin a PDFNet operation
execute an action defined by the first parameter generator and then finish this operation.
|
| <static> |
PDFNet.runGeneratorWithoutCleanup(generator, license_key)
This function is a utility method which will initialize PDFNet and
execute an action defined by the first parameter generator.
|
| <static> |
PDFNet.setColorManagement(t)
used to set a specific Color Management System (CMS) for
use during color conversion operators, image rendering, etc.
|
| <static> |
PDFNet.setDefaultDeviceRGBProfile(icc_filename)
sets the default ICC color profile for DeviceRGB color space.
|
| <static> |
PDFNet.setDefaultFlateCompressionLevel(level)
sets the default compression level for Flate (ZLib).
|
| <static> |
PDFNet.setLogLevel(level)
[Documentation Not Yet Added]
|
| <static> |
PDFNet.startDeallocateStack()
startDeallocateStack initializes a deallocation point.
|
Method Detail
<static>
PDFNet.beginOperation(optionsObj)
beginOperation locks all Emscripten worker operations on PDFNet so as to avoid
potential editing conflicts. Calling beginOperation a second time before
finishOperation is called will result in an exception being thrown. This can be
disabled allowing multiple beginOperations to be called by passing in an options
object (a default javascript object {}) with its parameter "allowMultipleInstances"
set to "true".
- Parameters:
- {obj} optionsObj Optional, Default: {}
- [optionsObj.allowMultipleInstances=false] If allowMultipleInstances set to true, multiple instances of beginOperation will be allowed.
<static>
PDFNet.deallocateAllObjects()
Removes all PDFNetJS objects from memory.
<static>
PDFNet.displayAllocatedObjects()
Displays in the console a list of objects still in memory in the form of their type and ID.
<static>
PDFNet.enableJavaScript(enable)
A switch that can be used to turn on/off JavaScript engine
- Parameters:
- {boolean} enable
- true to enable JavaScript engine, false to disable.
<static>
PDFNet.endDeallocateStack()
Deallocates all objects in memory that were created after the most recent startDeallocateStack call.
<static>
PDFNet.finishOperation()
finishOperation releases the lock on all Emscripten worker operations on PDFNet.
Will do nothing if PDFNet.beginOperation has not been called earlier.
<static>
{string}
PDFNet.getNormalizedUrl(url)
[Documentation Not Yet Added]
- Parameters:
- {string} url
- (generated documentation)
- Returns:
- {string} A promise that resolves to an object of type: "string" (generated documentation)
<static>
{Number}
PDFNet.getStackCount()
Gets the number of PDFNet.startDeallocateStack() calls made that have not yet been ended.
- Returns:
- {Number} A promise that resolves to the number of PDFNet.startDeallocateStack() calls not yet ended.
<static>
{number}
PDFNet.getVersion()
- Returns:
- {number} A promise that resolves to pDFNet version number.
<static>
{boolean}
PDFNet.isJavaScriptEnabled()
Test whether JavaScript is enabled
- Returns:
- {boolean} A promise that resolves to true if it is enabled, false otherwise
<static>
PDFNet.runGeneratorWithCleanup(generator, license_key)
This function is a utility method which will initialize PDFNet, begin a PDFNet operation
execute an action defined by the first parameter generator and then finish this operation.
This method will also clean up all PDFNet resources that are allocated
within the generator which can greatly simplify user code. In some cases the user
may wish to keep PDFNet objects alive out of the scope of this generator
function in which case runGeneratorWithoutCleanup should be used instead.
- Parameters:
- generator
- The generator function to execute.
- license_key
- the license key used to initialize PDFNet.
- Returns:
- a promise that resolves to the return value of the generator.
<static>
PDFNet.runGeneratorWithoutCleanup(generator, license_key)
This function is a utility method which will initialize PDFNet and
execute an action defined by the first parameter generator. Unlike
runGeneratorWithCleanup this method will not clean up PDFNet resources
which can be useful when the user wishes to keep some of the objects alive.
- Parameters:
- generator
- The generator function to execute.
- license_key
- the license key used to initialize PDFNet.
- Returns:
- a promise that resolves to the return value of the generator.
<static>
PDFNet.setColorManagement(t)
used to set a specific Color Management System (CMS) for
use during color conversion operators, image rendering, etc.
- Parameters:
- {number} t
- identifies the type of color management to use.
<static>
PDFNet.setDefaultDeviceRGBProfile(icc_filename)
sets the default ICC color profile for DeviceRGB color space.
- Parameters:
- {string} icc_filename
- (generated documentation)
<static>
PDFNet.setDefaultFlateCompressionLevel(level)
sets the default compression level for Flate (ZLib).
- Parameters:
- {number} level
- An integer in range 0-9 representing the compression value to use as a default for any Flate streams (e.g used to compress content streams, PNG images, etc). The library normally uses the default compression level (Z_DEFAULT_COMPRESSION). For most images, compression values in the range 3-6 compress nearly as well as higher levels, and do so much faster. For on-line applications it may be desirable to have maximum speed Z_BEST_SPEED = 1). You can also specify no compression (Z_NO_COMPRESSION = 0).
<static>
PDFNet.setLogLevel(level)
[Documentation Not Yet Added]
- Parameters:
- {number/enum} level
- (generated enum documentation)
PDFNet.LogLevel = { e_LogLevel_Off : -1 e_LogLevel_Fatal : 5 e_LogLevel_Error : 4 e_LogLevel_Warning : 3 e_LogLevel_Info : 2 e_LogLevel_Trace : 1 e_LogLevel_Debug : 0 }
<static>
PDFNet.startDeallocateStack()
startDeallocateStack initializes a deallocation point. All functions which create objects that take up
memory after the most recent startDeallocateStack call will be deallocated upon calling
PDFNet.endDeallocateStack().