happypdf / PDFCrossRefStream

Class: PDFCrossRefStream

Defined in: src/core/structures/PDFCrossRefStream.ts:41

Entries should be added using the [[addDeletedEntry]], [[addUncompressedEntry]], and [[addCompressedEntry]] methods

Extends

• PDFFlateStream

Properties

contentsCache

protected contentsCache: Cache<Uint8Array<ArrayBufferLike>>;

Defined in: src/core/structures/PDFFlateStream.ts:10

Inherited from

PDFFlateStream.contentsCache

---

dict

readonly dict: PDFDict;

Defined in: src/core/objects/PDFStream.ts:10

Inherited from

PDFFlateStream.dict

---

encode

protected readonly encode: boolean;

Defined in: src/core/structures/PDFFlateStream.ts:11

Inherited from

PDFFlateStream.encode

Methods

addCompressedEntry()

addCompressedEntry(
   ref, 
   objectStreamRef, 
   index): void;

Defined in: src/core/structures/PDFCrossRefStream.ts:93

Parameters

Parameter	Type
ref	PDFRef
objectStreamRef	PDFRef
index	number

Returns

void

---

addDeletedEntry()

addDeletedEntry(ref, nextFreeObjectNumber): void;

Defined in: src/core/structures/PDFCrossRefStream.ts:75

Parameters

Parameter	Type
ref	PDFRef
nextFreeObjectNumber	number

Returns

void

---

addUncompressedEntry()

addUncompressedEntry(ref, offset): void;

Defined in: src/core/structures/PDFCrossRefStream.ts:84

Parameters

Parameter	Type
ref	PDFRef
offset	number

Returns

void

---

clone()

clone(context?): PDFCrossRefStream;

Defined in: src/core/structures/PDFCrossRefStream.ts:102

Parameters

Parameter	Type
context?	PDFContext

Returns

PDFCrossRefStream

Overrides

PDFFlateStream.clone

---

computeContents()

computeContents(): Uint8Array;

Defined in: src/core/structures/PDFFlateStream.ts:22

Returns

Uint8Array

Inherited from

PDFFlateStream.computeContents

---

copyBytesInto()

copyBytesInto(buffer, offset): number;

Defined in: src/core/objects/PDFStream.ts:65

Parameters

Parameter	Type
buffer	Uint8Array
offset	number

Returns

number

Inherited from

PDFFlateStream.copyBytesInto

---

create()

static create(dict, encode?): PDFCrossRefStream;

Defined in: src/core/structures/PDFCrossRefStream.ts:42

Parameters

Parameter	Type	Default value
dict	PDFDict	undefined
encode	boolean	true

Returns

PDFCrossRefStream

---

getContents()

getContents(): Uint8Array;

Defined in: src/core/structures/PDFFlateStream.ts:27

Returns

Uint8Array

Inherited from

PDFFlateStream.getContents

---

getContentsSize()

getContentsSize(): number;

Defined in: src/core/structures/PDFFlateStream.ts:31

Returns

number

Inherited from

PDFFlateStream.getContentsSize

---

getContentsString()

getContentsString(): string;

Defined in: src/core/structures/PDFCrossRefStream.ts:107

Returns

string

Overrides

PDFFlateStream.getContentsString

---

getUnencodedContents()

getUnencodedContents(): Uint8Array;

Defined in: src/core/structures/PDFCrossRefStream.ts:137

Returns

Uint8Array

Overrides

PDFFlateStream.getUnencodedContents

---

getUnencodedContentsSize()

getUnencodedContentsSize(): number;

Defined in: src/core/structures/PDFCrossRefStream.ts:168

Returns

number

---

of()

static of(
   dict, 
   entries, 
   encode?): PDFCrossRefStream;

Defined in: src/core/structures/PDFCrossRefStream.ts:48

Parameters

Parameter	Type	Default value
dict	PDFDict	undefined
entries	Entry[]	undefined
encode	boolean	true

Returns

PDFCrossRefStream

---

registerChange()

registerChange(): void;

Defined in: src/core/objects/PDFObject.ts:5

Returns

void

Inherited from

PDFFlateStream.registerChange

---

sizeInBytes()

sizeInBytes(): number;

Defined in: src/core/objects/PDFStream.ts:51

Returns

number

Inherited from

PDFFlateStream.sizeInBytes

---

toString()

toString(): string;

Defined in: src/core/objects/PDFStream.ts:56

Returns

string

Inherited from

PDFFlateStream.toString

---

updateContents()

updateContents(contents): void;

Defined in: src/core/structures/PDFFlateStream.ts:42

Parameters

Parameter	Type
contents	Uint8Array

Returns

void

Inherited from

PDFFlateStream.updateContents

---

updateDict()

updateDict(): void;

Defined in: src/core/structures/PDFCrossRefStream.ts:174

Returns

void

Overrides

PDFFlateStream.updateDict