PDFTron pdfnet-node

Class: ObjSet

PDFNet. ObjSet

new ObjSet()

ObjSet is a lightweight container that can hold a collection of SDF objects.

Extends

Methods

<static> create()

Constructor
Returns:
A promise that resolves to an object of type: "PDFNet.ObjSet"
Type
Promise.<PDFNet.ObjSet>

createArray()

Create a new array object in this object set.
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createBool(value)

Create a new boolean object in this object set.
Parameters:
Name Type Description
value boolean The boolean value of the object to create
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createDict()

Create a new dictionary object in this object set.
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createFromJson(json)

parses a json string to create either a Dictionary or an Array in ObjSet. return the created object as Obj
Parameters:
Name Type Description
json string
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createName(name)

Create a new name object in this object set.
Parameters:
Name Type Description
name string The name of the object to create
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createNull()

Create a new null object in this object set.
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createNumber(value)

Create a new number object in this object set.
Parameters:
Name Type Description
value number The numeric value of the number object to create.
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

createString(value)

Create a new string object in this object set. The unsigned string value of the string object to create.
Parameters:
Name Type Description
value string
Returns:
A promise that resolves to an object of type: "PDFNet.Obj"
Type
Promise.<PDFNet.Obj>

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void