Class PDFArray

Implements

PDFArrayType

Index

Constructors

constructor

new PDFArray(options?: Options): PDFArray
Create a PDFArray instance. Instead of creating an instance in new mode, use create to create an instance.
Parameters
- Optionaloptions: Options
  Create a PDFArray instance with the specified options.
Returns PDFArray
Example
```
const pdfArr = await PDFArray.create();
```

Properties

`Optional`options

options?: Options

Methods

add

add(otherObj: PDFObjectType, doc: DocType): Promise<void>
Adding element.
Parameters
- otherObj: PDFObjectType
  The object to be added.
- doc: DocType
  The document object.
Returns Promise<void>
Implementation of PDFArrayType.add

addInteger

addInteger(value: number): Promise<void>
Add an integer to the PDFArray instance.
Parameters
- value: number
  The integer to be added.
Returns Promise<void>
Implementation of PDFArrayType.addInteger

addName

addName(name?: string): Promise<void>
Add a name object.
Parameters
- name: string = ''
  The name to be added.
Returns Promise<void>
Implementation of PDFArrayType.addName

addNew

addNew(obj: PDFObjectType, pdfObjectType: number): Promise<null | PDFObjectType>
Add an object element by object_type.
Parameters
- obj: PDFObjectType
  The object to be added.
- pdfObjectType: number
Returns Promise<null | PDFObjectType>
Implementation of PDFArrayType.addNew

addNumber

addNumber(num: number): Promise<void>
Add a number to the PDFArray instance.
Parameters
- num: number
  The number to be added.
Returns Promise<void>
Implementation of PDFArrayType.addNumber

addReference2ToDoc

addReference2ToDoc(doc: DocType, obj: PDFObjectType): Promise<void>
Add a reference object with object.
Parameters
- doc: DocType
  The document object.
- obj: PDFObjectType
  The referred object.
Returns Promise<void>
Implementation of PDFArrayType.addReference2ToDoc

addReferenceToDoc

addReferenceToDoc(doc: DocType, objNum: number): Promise<void>
Add a reference object with object number.
Parameters
- doc: DocType
  The document object.
- objNum: number
  The referred object number.
Returns Promise<void>
Implementation of PDFArrayType.addReferenceToDoc

addString

addString(str?: string): Promise<void>
Add a string object.
Parameters
- str: string = ''
  The string to be added.
Returns Promise<void>
Implementation of PDFArrayType.addString

destroy

destroy(): Promise<void>
Destroy the current object.

Returns Promise<void>
Implementation of PDFArrayType.destroy

getArray

getArray(index: number): Promise<null | PDFObjectType>
Get an array object with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<null | PDFObjectType>
Return an array object with specified position.

Implementation of PDFArrayType.getArray

getCount

getCount(): Promise<number>
Get the number of elements in the PDFArray instance.

Returns Promise<number>
Return the number of elements in the PDFArray instance.

Implementation of PDFArrayType.getCount

getDict

getDict(index: number): Promise<null | PDFDictionaryType>
Get a dictionary object with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<null | PDFDictionaryType>
Return a dictionary object with specified position.

Implementation of PDFArrayType.getDict

getElement

getElement(index: number): Promise<null | PDFObjectType>
Get reference to element. Returns direct reference to the element.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<null | PDFObjectType>
Return the element at the specified index in the PDFArray instance.

Implementation of PDFArrayType.getElement

getElementValue

getElementValue(index: number): Promise<null | PDFObjectType>
Get direct or referred indirect object at the specified index in the PDFArray instance.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<null | PDFObjectType>
Returns direct or referred indirect object.

Implementation of PDFArrayType.getElementValue

getFloat

getFloat(index: number): Promise<number>
Get a floating-point with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<number>
Implementation of PDFArrayType.getFloat

getInteger

getInteger(index: number): Promise<number>
Get an integer with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<number>
Return an integer with specified position.

Implementation of PDFArrayType.getInteger

getMatrix

getMatrix(): Promise<Matrix>
Get the matrix of the PDFArray instance.

Returns Promise<Matrix>
Return the matrix of the PDFArray instance.

Implementation of PDFArrayType.getMatrix

getNumber

getNumber(index: number): Promise<number>
Get a number with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<number>
Return a number with specified position.

Implementation of PDFArrayType.getNumber

getRect

getRect(): Promise<Rect>
Get the rectangle of the PDFArray instance.

Returns Promise<Rect>
Return the rectangle of the PDFArray instance.

Implementation of PDFArrayType.getRect

getStream

getStream(index: number): Promise<null | PDFObjectType>
Get a stream object with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<null | PDFObjectType>
Return a stream object with specified position.

Implementation of PDFArrayType.getStream

getString

getString(index: number): Promise<string>
Get the string with specified position.
Parameters
- index: number
  Specifies the zero-based index in the array.
Returns Promise<string>
Return the string with specified position.

Implementation of PDFArrayType.getString

insertAt

insertAt(options: InsertAtType): Promise<void>
Insert an element at specified position.
Parameters
- options: InsertAtType
  The options to insert an element at specified position.
Returns Promise<void>
Implementation of PDFArrayType.insertAt

isIdentical

isIdentical(otherArr: PDFArrayType): Promise<boolean>
Compare with another object.
Parameters
- otherArr: PDFArrayType
  PDFArrayType 实例
Returns Promise<boolean>
Implementation of PDFArrayType.isIdentical

release

release(): Promise<void>
Release the FPDArray.

Returns Promise<void>
Implementation of PDFArrayType.release

removeAt

removeAt(index: number): Promise<void>
Remove an element.
Parameters
- index: number
  The index of the element to be removed.
Returns Promise<void>
Implementation of PDFArrayType.removeAt

`Static`create

create(options?: Options): Promise<PDFArrayType>
Create a PDFArray instance.
Parameters
- Optionaloptions: Options
  Create a PDFArray instance with the specified options.
Returns Promise<PDFArrayType>
Return a PDFArray instance.