Skip to content

happypdf / PDFContentStream

Class: PDFContentStream

Defined in: src/core/structures/PDFContentStream.ts:7

Extends

Properties

contentsCache

ts
protected contentsCache: Cache<Uint8Array<ArrayBufferLike>>;

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

Inherited from

PDFFlateStream.contentsCache


dict

ts
readonly dict: PDFDict;

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

Inherited from

PDFFlateStream.dict


encode

ts
protected readonly encode: boolean;

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

Inherited from

PDFFlateStream.encode

Methods

clone()

ts
clone(context?): PDFContentStream;

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

Parameters

ParameterType
context?PDFContext

Returns

PDFContentStream

Overrides

PDFFlateStream.clone


computeContents()

ts
computeContents(): Uint8Array;

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

Returns

Uint8Array

Inherited from

PDFFlateStream.computeContents


copyBytesInto()

ts
copyBytesInto(buffer, offset): number;

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

Parameters

ParameterType
bufferUint8Array
offsetnumber

Returns

number

Inherited from

PDFFlateStream.copyBytesInto


getContents()

ts
getContents(): Uint8Array;

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

Returns

Uint8Array

Inherited from

PDFFlateStream.getContents


getContentsSize()

ts
getContentsSize(): number;

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

Returns

number

Inherited from

PDFFlateStream.getContentsSize


getContentsString()

ts
getContentsString(): string;

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

Returns

string

Overrides

PDFFlateStream.getContentsString


getUnencodedContents()

ts
getUnencodedContents(): Uint8Array;

Defined in: src/core/structures/PDFContentStream.ts:39

Returns

Uint8Array

Overrides

PDFFlateStream.getUnencodedContents


getUnencodedContentsSize()

ts
getUnencodedContentsSize(): number;

Defined in: src/core/structures/PDFContentStream.ts:49

Returns

number


of()

ts
static of(
   dict, 
   operators, 
   encode?): PDFContentStream;

Defined in: src/core/structures/PDFContentStream.ts:8

Parameters

ParameterTypeDefault value
dictPDFDictundefined
operatorsPDFOperator[]undefined
encodebooleantrue

Returns

PDFContentStream


push()

ts
push(...operators): void;

Defined in: src/core/structures/PDFContentStream.ts:18

Parameters

ParameterType
...operatorsPDFOperator[]

Returns

void


registerChange()

ts
registerChange(): void;

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

Returns

void

Inherited from

PDFFlateStream.registerChange


sizeInBytes()

ts
sizeInBytes(): number;

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

Returns

number

Inherited from

PDFFlateStream.sizeInBytes


toString()

ts
toString(): string;

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

Returns

string

Inherited from

PDFFlateStream.toString


updateContents()

ts
updateContents(contents): void;

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

Parameters

ParameterType
contentsUint8Array

Returns

void

Inherited from

PDFFlateStream.updateContents


updateDict()

ts
updateDict(): void;

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

Returns

void

Inherited from

PDFFlateStream.updateDict

MIT Licensed. A fork of pdf-lib.