Class PdfIndirectObject<T>

Type Parameters

T extends PdfObject = PdfObject

Hierarchy (View Summary)

PdfObjectReference
- PdfIndirectObject

Index

Constructors

Properties

content encryptable? generationNumber modified objectNumber offset orderIndex? postTokens? preTokens? MAX_ORDER_INDEX

Accessors

objectType reference

Methods

as clone equals inPdf isEncryptable isModified matchesReference order setModified toBytes tokenize toString toTokens createPlaceholder

Constructors

constructor

new PdfIndirectObject<T extends PdfObject = PdfObject>(
    options:
        | T
        | {
            content: T;
            encryptable?: boolean;
            generationNumber?: number;
            objectNumber?: number;
            offset?: number
            | Ref<number>;
        },
): PdfIndirectObject<T>
Type Parameters
- T extends PdfObject = PdfObject
Parameters
- options:
      | T
      | {
          content: T;
          encryptable?: boolean;
          generationNumber?: number;
          objectNumber?: number;
          offset?: number
          | Ref<number>;
      }
Returns PdfIndirectObject<T>
Overrides PdfObjectReference.constructor
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:21

Properties

content

content: T

`Optional`encryptable

encryptable?: boolean

generationNumber

generationNumber: number

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

objectNumber

objectNumber: number

offset

offset: Ref<number>

`Optional`orderIndex

orderIndex?: number

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Static` `Readonly`MAX_ORDER_INDEX

MAX_ORDER_INDEX: 2147483647

Accessors

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfObjectReference.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:17

reference

get reference(): PdfObjectReference
Returns PdfObjectReference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:48

Methods

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfObjectReference.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep clone of the object

Returns this
Overrides PdfObjectReference.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:117

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfObjectReference.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:79

inPdf

inPdf(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:92

isEncryptable

isEncryptable(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:66

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Overrides PdfObjectReference.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:130

matchesReference

matchesReference(ref?: PdfObjectReference): boolean
Parameters
- Optionalref: PdfObjectReference
Returns boolean
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:96

order

order(): number
Returns number
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:126

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfObjectReference.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfObjectReference.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:41

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Overrides PdfObjectReference.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:106

toString

toString(): string
Converts the object to a string representation

Returns string
Inherited from PdfObjectReference.toString
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:56

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfObjectReference.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

`Static`createPlaceholder

createPlaceholder<T extends PdfObject>(
    objectNumber?: number,
    generationNumber?: number,
    content?: T,
): PdfIndirectObject<T extends unknown ? PdfNull : T>
Type Parameters
- T extends PdfObject
Parameters
- OptionalobjectNumber: number
- OptionalgenerationNumber: number
- Optionalcontent: T
Returns PdfIndirectObject<T extends unknown ? PdfNull : T>
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:79