Class PdfRevision

Represents a single revision of a PDF document. PDF documents can have multiple revisions for incremental updates, where each revision contains its own set of objects and cross-reference table.

Hierarchy (View Summary)

PdfObject
- PdfRevision

Index

Constructors

constructor

new PdfRevision(
    options?: {
        locked?: boolean;
        objects?: PdfObject[];
        prev?: PdfXrefLookup | PdfRevision;
    },
): PdfRevision
Creates a new PDF revision.
Parameters
- Optionaloptions: { locked?: boolean; objects?: PdfObject[]; prev?: PdfXrefLookup | PdfRevision }
  Configuration options for the revision
  - Optionallocked?: boolean
    Whether the revision should be locked initially
  - Optionalobjects?: PdfObject[]
    Initial objects for this revision
  - Optionalprev?: PdfXrefLookup | PdfRevision
    Previous revision or xref lookup to link to
Returns PdfRevision
Overrides PdfObject.constructor
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:30

Properties

locked

locked: boolean = false

Whether this revision is locked (cannot be modified)

`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

objects

objects: PdfObject[] = []

Objects contained in this revision

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

xref

xref: PdfXrefLookup

Cross-reference lookup table for this revision

Accessors

objectType

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

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

trailerDict

get trailerDict(): PdfDictionary<PdfTrailerEntries>
Gets the trailer dictionary for this revision.

Returns PdfDictionary<PdfTrailerEntries>
The trailer dictionary containing document metadata references
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:214

Methods

addObject

addObject(...objects: PdfObject[]): void
Adds objects to the revision.
Parameters
- ...objects: PdfObject[]
  Objects to add to the revision
Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:99

addObjectAt

addObjectAt(object: PdfObject, index?: number | PdfObject): void
Adds an object at a specific position in the revision.
Parameters
- object: PdfObject
  The object to add
- Optionalindex: number | PdfObject
  Position to insert at (number) or object to insert before
Returns void
Throws
Error if the revision is locked or index is out of bounds
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:112

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 PdfObject.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep copy of this revision.

Returns this
A cloned PdfRevision instance
Overrides PdfObject.clone
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:223

contains

contains(object: PdfObject): boolean
Checks if an object reference exists in this revision.
Parameters
- object: PdfObject
  The object to check for
Returns boolean
True if the exact object instance exists in this revision
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:63

deleteObject

deleteObject(...objects: PdfObject[]): void
Removes objects from the revision.
Parameters
- ...objects: PdfObject[]
  Objects to remove from the revision
Returns void
Throws
Error if the revision is locked
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:152

equals

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

exists

exists(object: PdfObject): boolean
Checks if an equivalent object exists in this revision (by value equality).
Parameters
- object: PdfObject
  The object to check for
Returns boolean
True if an equal object exists in this revision
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:73

isModified

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

Returns boolean
Overrides PdfObject.isModified
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:172

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 PdfObject.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

setPrev

setPrev(xref: PdfXrefLookup | PdfRevision): void
Links this revision to a previous revision's cross-reference table.
Parameters
- xref: PdfXrefLookup | PdfRevision
  The previous revision's xref lookup or revision
Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:52

sortObjects

sortObjects(): void
Sorts objects by their insertion order. Indirect objects are placed before other objects.

Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:196

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfObject.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 PdfObject.tokenize
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:228

toString

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

Returns string
Inherited from PdfObject.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 PdfObject.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

unshift

unshift(...objects: PdfObject[]): void
Adds objects to the beginning of the revision's object list.
Parameters
- ...objects: PdfObject[]
  Objects to add at the beginning
Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:87

update

update(): void
Updates the revision by sorting objects and updating the xref table.

Returns void
- Defined in packages/pdf-lite/src/pdf/pdf-revision.ts:183

Class PdfRevision

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionallocked?: boolean

Optionalobjects?: PdfObject[]

Optionalprev?: PdfXrefLookup | PdfRevision

Returns PdfRevision

Properties

locked

Protectedmodified

objects

OptionalpostTokens

OptionalpreTokens

xref

Accessors

objectType

Returns string

trailerDict

Returns PdfDictionary<PdfTrailerEntries>

Methods

addObject

Parameters

Returns void

addObjectAt

Parameters

Returns void

Throws

as

Type Parameters

Parameters

Returns T

clone

Returns this

contains

Parameters

Returns boolean

deleteObject

Parameters

Returns void

Throws

equals

Parameters

Returns boolean

exists

Parameters

Returns boolean

isModified

Returns boolean

setModified

Parameters

Returns void

setPrev

Parameters

Returns void

sortObjects

Returns void

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfToken[]

toString

Returns string

toTokens

Returns PdfToken[]

unshift

Parameters

Returns void

update

Returns void

Settings

On This Page

`Optional`locked?: boolean

`Optional`objects?: PdfObject[]

`Optional`prev?: PdfXrefLookup | PdfRevision

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize