Skip to content

PDFCatalogObject Extends PDFIndirectBaseObject ​

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

Constructor object/indirect/catalog.ts:7 ​

new PDFCatalogObject(options): PDFCatalogObject

Parameters ​

ParameterType
object
BasePDFPagesObject
generation?number
id?number

Returns ​

PDFCatalogObject

Overrides ​

PDFIndirectBaseObject.constructor

Properties ​

PropertyModifierTypeDefault valueOverridesInherited from
_type
catalog.ts:5
publicstring"catalog"PDFIndirectBaseObject._type-
generation?
baseIndirect.ts:7
publicnumberundefined-PDFIndirectBaseObject.generation
id?
baseIndirect.ts:6
publicnumberundefined-PDFIndirectBaseObject.id
value
baseIndirect.ts:8
publicanyundefined-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 ​

ParameterType
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

Released under the MIT License.