happypdf / PDFDict

Class: PDFDict

Defined in: src/core/objects/PDFDict.ts:16

Extends

• PDFObject

Extended by

• PDFCatalog
• PDFPageTree
• PDFPageLeaf

Constructors

Constructor

protected new PDFDict(map, context): PDFDict;

Defined in: src/core/objects/PDFDict.ts:28

Parameters

Parameter	Type
map	DictMap
context	PDFContext

Returns

PDFDict

Overrides

PDFObject.constructor

Properties

context

readonly context: PDFContext;

Defined in: src/core/objects/PDFDict.ts:22

---

suppressEncryption

suppressEncryption: boolean = false;

Defined in: src/core/objects/PDFDict.ts:26

Methods

asMap()

asMap(): Map<PDFName, PDFObject>;

Defined in: src/core/objects/PDFDict.ts:162

Returns

Map<PDFName, PDFObject>

---

clone()

clone(context?): PDFDict;

Defined in: src/core/objects/PDFDict.ts:176

Parameters

Parameter	Type
context?	PDFContext

Returns

PDFDict

Overrides

PDFObject.clone

---

copyBytesInto()

copyBytesInto(buffer, offset): number;

Defined in: src/core/objects/PDFDict.ts:207

Parameters

Parameter	Type
buffer	Uint8Array
offset	number

Returns

number

Overrides

PDFObject.copyBytesInto

---

delete()

delete(key): boolean;

Defined in: src/core/objects/PDFDict.ts:157

Parameters

Parameter	Type
key	PDFName

Returns

boolean

---

entries()

entries(): [PDFName, PDFObject][];

Defined in: src/core/objects/PDFDict.ts:42

Returns

[PDFName, PDFObject][]

---

fromMapWithContext()

static fromMapWithContext(map, context): PDFDict;

Defined in: src/core/objects/PDFDict.ts:19

Parameters

Parameter	Type
map	DictMap
context	PDFContext

Returns

PDFDict

---

get()

get(key, preservePDFNull?): PDFObject | undefined;

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

Parameters

Parameter	Type	Default value
key	PDFName	undefined
preservePDFNull	boolean	false

Returns

PDFObject | undefined

---

has()

has(key): boolean;

Defined in: src/core/objects/PDFDict.ts:62

Parameters

Parameter	Type
key	PDFName

Returns

boolean

---

keys()

keys(): PDFName[];

Defined in: src/core/objects/PDFDict.ts:34

Returns

PDFName[]

---

lookup()

Call Signature

lookup(key): PDFObject | undefined;

Defined in: src/core/objects/PDFDict.ts:113

Parameters

Parameter	Type
key	PDFName

Returns

PDFObject | undefined

Call Signature

lookup(key, type): PDFArray;

Defined in: src/core/objects/PDFDict.ts:114

Parameters

Parameter	Type
key	PDFName
type	typeof PDFArray

Returns

PDFArray

Call Signature

lookup(key, type): PDFBool;

Defined in: src/core/objects/PDFDict.ts:115

Parameters

Parameter	Type
key	PDFName
type	typeof PDFBool

Returns

PDFBool

Call Signature

lookup(key, type): PDFDict;

Defined in: src/core/objects/PDFDict.ts:116

Parameters

Parameter	Type
key	PDFName
type	typeof PDFDict

Returns

PDFDict

Call Signature

lookup(key, type): PDFHexString;

Defined in: src/core/objects/PDFDict.ts:117

Parameters

Parameter	Type
key	PDFName
type	typeof PDFHexString

Returns

PDFHexString

Call Signature

lookup(key, type): PDFName;

Defined in: src/core/objects/PDFDict.ts:118

Parameters

Parameter	Type
key	PDFName
type	typeof PDFName

Returns

PDFName

Call Signature

lookup(key, type): PDFNull;

Defined in: src/core/objects/PDFDict.ts:119

Parameters

Parameter	Type
key	PDFName
type	PDFNull

Returns

PDFNull

Call Signature

lookup(key, type): PDFNumber;

Defined in: src/core/objects/PDFDict.ts:120

Parameters

Parameter	Type
key	PDFName
type	typeof PDFNumber

Returns

PDFNumber

Call Signature

lookup(key, type): PDFStream;

Defined in: src/core/objects/PDFDict.ts:121

Parameters

Parameter	Type
key	PDFName
type	typeof PDFStream

Returns

PDFStream

Call Signature

lookup(key, type): PDFRef;

Defined in: src/core/objects/PDFDict.ts:122

Parameters

Parameter	Type
key	PDFName
type	typeof PDFRef

Returns

PDFRef

Call Signature

lookup(key, type): PDFString;

Defined in: src/core/objects/PDFDict.ts:123

Parameters

Parameter	Type
key	PDFName
type	typeof PDFString

Returns

PDFString

Call Signature

lookup(
   ref, 
   type1, 
   type2): PDFHexString | PDFString;

Defined in: src/core/objects/PDFDict.ts:124

Parameters

Parameter	Type
ref	PDFName
type1	typeof PDFString
type2	typeof PDFHexString

Returns

PDFHexString | PDFString

Call Signature

lookup(
   ref, 
   type1, 
   type2): PDFStream | PDFDict;

Defined in: src/core/objects/PDFDict.ts:129

Parameters

Parameter	Type
ref	PDFName
type1	typeof PDFDict
type2	typeof PDFStream

Returns

PDFStream | PDFDict

Call Signature

lookup(
   ref, 
   type1, 
   type2, 
   type3): 
  | PDFHexString
  | PDFString
  | PDFArray;

Defined in: src/core/objects/PDFDict.ts:134

Parameters

Parameter	Type
ref	PDFName
type1	typeof PDFString
type2	typeof PDFHexString
type3	typeof PDFArray

Returns

| PDFHexString | PDFString | PDFArray

---

lookupMaybe()

Call Signature

lookupMaybe(key, type): PDFArray | undefined;

Defined in: src/core/objects/PDFDict.ts:67

Parameters

Parameter	Type
key	PDFName
type	typeof PDFArray

Returns

PDFArray | undefined

Call Signature

lookupMaybe(key, type): PDFBool | undefined;

Defined in: src/core/objects/PDFDict.ts:68

Parameters

Parameter	Type
key	PDFName
type	typeof PDFBool

Returns

PDFBool | undefined

Call Signature

lookupMaybe(key, type): PDFDict | undefined;

Defined in: src/core/objects/PDFDict.ts:69

Parameters

Parameter	Type
key	PDFName
type	typeof PDFDict

Returns

PDFDict | undefined

Call Signature

lookupMaybe(key, type): PDFHexString | undefined;

Defined in: src/core/objects/PDFDict.ts:70

Parameters

Parameter	Type
key	PDFName
type	typeof PDFHexString

Returns

PDFHexString | undefined

Call Signature

lookupMaybe(key, type): PDFName | undefined;

Defined in: src/core/objects/PDFDict.ts:74

Parameters

Parameter	Type
key	PDFName
type	typeof PDFName

Returns

PDFName | undefined

Call Signature

lookupMaybe(key, type): PDFNull | undefined;

Defined in: src/core/objects/PDFDict.ts:75

Parameters

Parameter	Type
key	PDFName
type	PDFNull

Returns

PDFNull | undefined

Call Signature

lookupMaybe(key, type): PDFNumber | undefined;

Defined in: src/core/objects/PDFDict.ts:76

Parameters

Parameter	Type
key	PDFName
type	typeof PDFNumber

Returns

PDFNumber | undefined

Call Signature

lookupMaybe(key, type): PDFStream | undefined;

Defined in: src/core/objects/PDFDict.ts:77

Parameters

Parameter	Type
key	PDFName
type	typeof PDFStream

Returns

PDFStream | undefined

Call Signature

lookupMaybe(key, type): PDFRef | undefined;

Defined in: src/core/objects/PDFDict.ts:78

Parameters

Parameter	Type
key	PDFName
type	typeof PDFRef

Returns

PDFRef | undefined

Call Signature

lookupMaybe(key, type): PDFString | undefined;

Defined in: src/core/objects/PDFDict.ts:79

Parameters

Parameter	Type
key	PDFName
type	typeof PDFString

Returns

PDFString | undefined

Call Signature

lookupMaybe(
   ref, 
   type1, 
   type2): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/objects/PDFDict.ts:80

Parameters

Parameter	Type
ref	PDFName
type1	typeof PDFString
type2	typeof PDFHexString

Returns

| PDFHexString | PDFString | undefined

Call Signature

lookupMaybe(
   ref, 
   type1, 
   type2): PDFStream | PDFDict | undefined;

Defined in: src/core/objects/PDFDict.ts:85

Parameters

Parameter	Type
ref	PDFName
type1	typeof PDFDict
type2	typeof PDFStream

Returns

PDFStream | PDFDict | undefined

Call Signature

lookupMaybe(
   ref, 
   type1, 
   type2, 
   type3): 
  | PDFHexString
  | PDFString
  | PDFArray
  | undefined;

Defined in: src/core/objects/PDFDict.ts:90

Parameters

Parameter	Type
ref	PDFName
type1	typeof PDFString
type2	typeof PDFHexString
type3	typeof PDFArray

Returns

| PDFHexString | PDFString | PDFArray | undefined

---

registerChange()

registerChange(): void;

Defined in: src/core/objects/PDFDict.ts:229

Returns

void

Overrides

PDFObject.registerChange

---

set()

set(key, value): void;

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

Parameters

Parameter	Type
key	PDFName
value	PDFObject

Returns

void

---

sizeInBytes()

sizeInBytes(): number;

Defined in: src/core/objects/PDFDict.ts:197

Returns

number

Overrides

PDFObject.sizeInBytes

---

toString()

toString(): string;

Defined in: src/core/objects/PDFDict.ts:186

Returns

string

Overrides

PDFObject.toString

---

uniqueKey()

uniqueKey(tag?): PDFName;

Defined in: src/core/objects/PDFDict.ts:167

Generate a random key that doesn't exist in current key set

Parameters

Parameter	Type	Default value
tag	string	''

Returns

PDFName

---

values()

values(): PDFObject[];

Defined in: src/core/objects/PDFDict.ts:38

Returns

PDFObject[]

---

withContext()

static withContext(context): PDFDict;

Defined in: src/core/objects/PDFDict.ts:17

Parameters

Parameter	Type
context	PDFContext

Returns

PDFDict