Class PDFArray

Implements

PDFArrayType

Index

Constructors

constructor

new PDFArray(options?: Options): PDFArray
创建一个 PDFArray 实例。请使用 create 方法来创建实例，而不是通过 new 关键字创建。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 PDFArray 实例。
Returns PDFArray
Example
```
const pdfArr = await PDFArray.create();
```

Properties

`Optional`options

options?: Options

Methods

add

add(otherObj: PDFObjectType, doc: DocType): Promise<void>
添加元素。
Parameters
- otherObj: PDFObjectType
  要添加的对象。
- doc: DocType
  文档对象。
Returns Promise<void>
Implementation of PDFArrayType.add

addInteger

addInteger(value: number): Promise<void>
向 PDFArray 实例添加一个整数。
Parameters
- value: number
  要添加的整数。
Returns Promise<void>
Implementation of PDFArrayType.addInteger

addName

addName(name?: string): Promise<void>
添加一个名称对象。
Parameters
- name: string = ''
  要添加的名称。
Returns Promise<void>
Implementation of PDFArrayType.addName

addNew

addNew(obj: PDFObjectType, pdfObjectType: number): Promise<null | PDFObjectType>
通过 object_type 添加一个对象元素。
Parameters
- obj: PDFObjectType
  要添加的对象。
- pdfObjectType: number
Returns Promise<null | PDFObjectType>
Implementation of PDFArrayType.addNew

addNumber

addNumber(num: number): Promise<void>
向 PDFArray 实例添加一个数字。
Parameters
- num: number
  要添加的数字。
Returns Promise<void>
Implementation of PDFArrayType.addNumber

addReference2ToDoc

addReference2ToDoc(doc: DocType, obj: PDFObjectType): Promise<void>
添加一个引用对象及其对象。
Parameters
- doc: DocType
  文档对象。
- obj: PDFObjectType
  被引用的对象。
Returns Promise<void>
Implementation of PDFArrayType.addReference2ToDoc

addReferenceToDoc

addReferenceToDoc(doc: DocType, objNum: number): Promise<void>
添加一个带有对象编号的引用对象。
Parameters
- doc: DocType
  文档对象。
- objNum: number
  被引用的对象编号。
Returns Promise<void>
Implementation of PDFArrayType.addReferenceToDoc

addString

addString(str?: string): Promise<void>
添加一个字符串对象。
Parameters
- str: string = ''
  要添加的字符串。
Returns Promise<void>
Implementation of PDFArrayType.addString

destroy

destroy(): Promise<void>
销毁当前对象。

Returns Promise<void>
Implementation of PDFArrayType.destroy

getArray

getArray(index: number): Promise<null | PDFObjectType>
获取指定位置的数组对象。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<null | PDFObjectType>
返回指定位置的数组对象。

Implementation of PDFArrayType.getArray

getCount

getCount(): Promise<number>
获取 PDFArray 实例中的元素数量。

Returns Promise<number>
返回 PDFArray 实例中的元素数量。

Implementation of PDFArrayType.getCount

getDict

getDict(index: number): Promise<null | PDFDictionaryType>
获取指定位置的字典对象。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<null | PDFDictionaryType>
返回指定位置的字典对象。

Implementation of PDFArrayType.getDict

getElement

getElement(index: number): Promise<null | PDFObjectType>
获取元素的引用。返回对该元素的直接引用。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<null | PDFObjectType>
返回 PDFArray 实例中指定索引处的元素。

Implementation of PDFArrayType.getElement

getElementValue

getElementValue(index: number): Promise<null | PDFObjectType>
获取 PDFArray 实例中指定索引位置的直接对象或其引用的间接对象。
Parameters
- index: number
  指定数组中的从零开始的索引。
Returns Promise<null | PDFObjectType>
返回直接对象或其引用的间接对象。

Implementation of PDFArrayType.getElementValue

getFloat

getFloat(index: number): Promise<number>
获取指定位置的浮点数。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<number>
Implementation of PDFArrayType.getFloat

getInteger

getInteger(index: number): Promise<number>
获取指定位置的整数。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<number>
返回指定位置的整数。

Implementation of PDFArrayType.getInteger

getMatrix

getMatrix(): Promise<Matrix>
获取 PDFArray 实例的矩阵。

Returns Promise<Matrix>
返回 PDFArray 实例的矩阵。

Implementation of PDFArrayType.getMatrix

getNumber

getNumber(index: number): Promise<number>
获取指定位置的数字。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<number>
返回指定位置的数字。

Implementation of PDFArrayType.getNumber

getRect

getRect(): Promise<Rect>
获取 PDFArray 实例的矩形。

Returns Promise<Rect>
返回 PDFArray 实例的矩形。

Implementation of PDFArrayType.getRect

getStream

getStream(index: number): Promise<null | PDFObjectType>
获取指定位置的流对象。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<null | PDFObjectType>
返回指定位置的流对象。

Implementation of PDFArrayType.getStream

getString

getString(index: number): Promise<string>
获取指定位置的字符串。
Parameters
- index: number
  指定数组中从零开始的索引。
Returns Promise<string>
返回指定位置的字符串。

Implementation of PDFArrayType.getString

insertAt

insertAt(options: InsertAtType): Promise<void>
在指定位置插入一个元素。
Parameters
- options: InsertAtType
  在指定位置插入元素的选项。
Returns Promise<void>
Implementation of PDFArrayType.insertAt

isIdentical

isIdentical(otherArr: PDFArrayType): Promise<boolean>
与另一个对象进行比较。
Parameters
- otherArr: PDFArrayType
  PDFArrayType 实例
Returns Promise<boolean>
Implementation of PDFArrayType.isIdentical

release

release(): Promise<void>
释放 FPDArray。

Returns Promise<void>
Implementation of PDFArrayType.release

removeAt

removeAt(index: number): Promise<void>
移除一个元素。
Parameters
- index: number
  要移除的元素索引。
Returns Promise<void>
Implementation of PDFArrayType.removeAt

`Static`create

create(options?: Options): Promise<PDFArrayType>
创建一个 PDFArray 实例。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 PDFArray 实例。
Returns Promise<PDFArrayType>
返回一个 PDFArray 实例。