PDFCatalogObject Extends PDFIndirectBaseObject

Defined in: object/indirect/catalog.ts:4

Constructor object/indirect/catalog.ts:7

new PDFCatalogObject(options): PDFCatalogObject

Parameters

Parameter	Type
options	object
Base	PDFPagesObject
generation?	number
id?	number

Returns

PDFCatalogObject

Overrides

PDFIndirectBaseObject.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from
_type catalog.ts:5	public	string	"catalog"	PDFIndirectBaseObject._type	-
generation? baseIndirect.ts:7	public	number	undefined	-	PDFIndirectBaseObject.generation
id? baseIndirect.ts:6	public	number	undefined	-	PDFIndirectBaseObject.id
value baseIndirect.ts:8	public	any	undefined	-	PDFIndirectBaseObject.value

Methods

getChildren() object/indirect/baseIndirect.ts:48

getChildren(): (PDFIndirectBaseObject | undefined)[]

Returns

(PDFIndirectBaseObject | undefined)[]

Inherited from

PDFIndirectBaseObject.getChildren

toBuffer() object/indirect/baseIndirect.ts:25

toBuffer(encryptFn?, encryptStreamFn?, compressOverride?): Buffer

Parameters

Parameter	Type
encryptFn?	(str) => string
encryptStreamFn?	(data) => Buffer
compressOverride?	boolean

Returns

Buffer

Inherited from

PDFIndirectBaseObject.toBuffer

toRef() object/indirect/baseIndirect.ts:16

toRef(): PDFReferenceObject

Returns

PDFReferenceObject

Inherited from

PDFIndirectBaseObject.toRef

toString() object/indirect/baseIndirect.ts:20

toString(): string

Returns

string

Inherited from

PDFIndirectBaseObject.toString