happypdf / PDFArray

Class: PDFArray

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

Extends

• PDFObject

Methods

asArray()

asArray(): PDFObject[];

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

Returns

PDFObject[]

---

asRectangle()

asRectangle(): {
  height: number;
  width: number;
  x: number;
  y: number;
};

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

Returns

{
  height: number;
  width: number;
  x: number;
  y: number;
}

height

height: number;

width

width: number;

x

x: number;

y

y: number;

---

clone()

clone(context?): PDFArray;

Defined in: src/core/objects/PDFArray.ts:138

Parameters

Parameter	Type
context?	PDFContext

Returns

PDFArray

Overrides

PDFObject.clone

---

copyBytesInto()

copyBytesInto(buffer, offset): number;

Defined in: src/core/objects/PDFArray.ts:164

Parameters

Parameter	Type
buffer	Uint8Array
offset	number

Returns

number

Overrides

PDFObject.copyBytesInto

---

get()

get(index): PDFObject;

Defined in: src/core/objects/PDFArray.ts:57

Parameters

Parameter	Type
index	number

Returns

PDFObject

---

indexOf()

indexOf(object): number | undefined;

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

Parameters

Parameter	Type
object	PDFObject

Returns

number | undefined

---

insert()

insert(index, object): void;

Defined in: src/core/objects/PDFArray.ts:37

Parameters

Parameter	Type
index	number
object	PDFObject

Returns

void

---

lookup()

Call Signature

lookup(index): PDFObject | undefined;

Defined in: src/core/objects/PDFArray.ts:92

Parameters

Parameter	Type
index	number

Returns

PDFObject | undefined

Call Signature

lookup(index, type): PDFArray;

Defined in: src/core/objects/PDFArray.ts:93

Parameters

Parameter	Type
index	number
type	typeof PDFArray

Returns

PDFArray

Call Signature

lookup(index, type): PDFBool;

Defined in: src/core/objects/PDFArray.ts:94

Parameters

Parameter	Type
index	number
type	typeof PDFBool

Returns

PDFBool

Call Signature

lookup(index, type): PDFDict;

Defined in: src/core/objects/PDFArray.ts:95

Parameters

Parameter	Type
index	number
type	typeof PDFDict

Returns

PDFDict

Call Signature

lookup(index, type): PDFHexString;

Defined in: src/core/objects/PDFArray.ts:96

Parameters

Parameter	Type
index	number
type	typeof PDFHexString

Returns

PDFHexString

Call Signature

lookup(index, type): PDFName;

Defined in: src/core/objects/PDFArray.ts:97

Parameters

Parameter	Type
index	number
type	typeof PDFName

Returns

PDFName

Call Signature

lookup(index, type): PDFNull;

Defined in: src/core/objects/PDFArray.ts:98

Parameters

Parameter	Type
index	number
type	PDFNull

Returns

PDFNull

Call Signature

lookup(index, type): PDFNumber;

Defined in: src/core/objects/PDFArray.ts:99

Parameters

Parameter	Type
index	number
type	typeof PDFNumber

Returns

PDFNumber

Call Signature

lookup(index, type): PDFStream;

Defined in: src/core/objects/PDFArray.ts:100

Parameters

Parameter	Type
index	number
type	typeof PDFStream

Returns

PDFStream

Call Signature

lookup(index, type): PDFRawStream;

Defined in: src/core/objects/PDFArray.ts:101

Parameters

Parameter	Type
index	number
type	typeof PDFRawStream

Returns

PDFRawStream

Call Signature

lookup(index, type): PDFRef;

Defined in: src/core/objects/PDFArray.ts:102

Parameters

Parameter	Type
index	number
type	typeof PDFRef

Returns

PDFRef

Call Signature

lookup(index, type): PDFString;

Defined in: src/core/objects/PDFArray.ts:103

Parameters

Parameter	Type
index	number
type	typeof PDFString

Returns

PDFString

Call Signature

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

Defined in: src/core/objects/PDFArray.ts:104

Parameters

Parameter	Type
index	number
type1	typeof PDFString
type2	typeof PDFHexString

Returns

PDFHexString | PDFString

---

lookupMaybe()

Call Signature

lookupMaybe(index, type): PDFArray | undefined;

Defined in: src/core/objects/PDFArray.ts:61

Parameters

Parameter	Type
index	number
type	typeof PDFArray

Returns

PDFArray | undefined

Call Signature

lookupMaybe(index, type): PDFBool | undefined;

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

Parameters

Parameter	Type
index	number
type	typeof PDFBool

Returns

PDFBool | undefined

Call Signature

lookupMaybe(index, type): PDFDict | undefined;

Defined in: src/core/objects/PDFArray.ts:63

Parameters

Parameter	Type
index	number
type	typeof PDFDict

Returns

PDFDict | undefined

Call Signature

lookupMaybe(index, type): PDFHexString | undefined;

Defined in: src/core/objects/PDFArray.ts:64

Parameters

Parameter	Type
index	number
type	typeof PDFHexString

Returns

PDFHexString | undefined

Call Signature

lookupMaybe(index, type): PDFName | undefined;

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

Parameters

Parameter	Type
index	number
type	typeof PDFName

Returns

PDFName | undefined

Call Signature

lookupMaybe(index, type): PDFNull | undefined;

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

Parameters

Parameter	Type
index	number
type	PDFNull

Returns

PDFNull | undefined

Call Signature

lookupMaybe(index, type): PDFNumber | undefined;

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

Parameters

Parameter	Type
index	number
type	typeof PDFNumber

Returns

PDFNumber | undefined

Call Signature

lookupMaybe(index, type): PDFStream | undefined;

Defined in: src/core/objects/PDFArray.ts:71

Parameters

Parameter	Type
index	number
type	typeof PDFStream

Returns

PDFStream | undefined

Call Signature

lookupMaybe(index, type): PDFRawStream | undefined;

Defined in: src/core/objects/PDFArray.ts:72

Parameters

Parameter	Type
index	number
type	typeof PDFRawStream

Returns

PDFRawStream | undefined

Call Signature

lookupMaybe(index, type): PDFRef | undefined;

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

Parameters

Parameter	Type
index	number
type	typeof PDFRef

Returns

PDFRef | undefined

Call Signature

lookupMaybe(index, type): PDFString | undefined;

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

Parameters

Parameter	Type
index	number
type	typeof PDFString

Returns

PDFString | undefined

Call Signature

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

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

Parameters

Parameter	Type
index	number
type1	typeof PDFString
type2	typeof PDFHexString

Returns

| PDFHexString | PDFString | undefined

---

push()

push(object): void;

Defined in: src/core/objects/PDFArray.ts:32

Parameters

Parameter	Type
object	PDFObject

Returns

void

---

registerChange()

registerChange(): void;

Defined in: src/core/objects/PDFArray.ts:188

Returns

void

Overrides

PDFObject.registerChange

---

remove()

remove(index): void;

Defined in: src/core/objects/PDFArray.ts:47

Parameters

Parameter	Type
index	number

Returns

void

---

scalePDFNumbers()

scalePDFNumbers(x, y): void;

Defined in: src/core/objects/PDFArray.ts:178

Parameters

Parameter	Type
x	number
y	number

Returns

void

---

set()

set(idx, object): void;

Defined in: src/core/objects/PDFArray.ts:52

Parameters

Parameter	Type
idx	number
object	PDFObject

Returns

void

---

size()

size(): number;

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

Returns

number

---

sizeInBytes()

sizeInBytes(): number;

Defined in: src/core/objects/PDFArray.ts:156

Returns

number

Overrides

PDFObject.sizeInBytes

---

toString()

toString(): string;

Defined in: src/core/objects/PDFArray.ts:146

Returns

string

Overrides

PDFObject.toString

---

withContext()

static withContext(context): PDFArray;

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

Parameters

Parameter	Type
context	PDFContext

Returns

PDFArray