Class PDFDictionary

Implements

PDFDictionaryType

Constructors

constructor

new PDFDictionary(options?: Options): PDFDictionary
创建一个 PDFDictionary 实例。不要通过 new 模式创建实例，而应使用 create 来创建实例。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 PDFDictionary 实例。
Returns PDFDictionary
Example
```
const pdfDictionary = await PDFDictionary.create();
```

Properties

options

options: Options

Methods

addReference

addReference(key: string, doc: DocType, objNum: number): Promise<void>
为由 key 指定的元素添加一个引用对象。
Parameters
- key: string
  输入的键字符串。
- doc: DocType
  输入的文档对象。
- objNum: number
  引用对象所指向的对象编号。
Returns Promise<void>
Implementation of PDFDictionaryType.addReference

addValue

addValue(key: string, obj: AddValueObjType): Promise<void>
向字典中添加新的键值对。
Parameters
- key: string
  输入的键字符串。
- obj: AddValueObjType
  输入的值对象。
Returns Promise<void>
Implementation of PDFDictionaryType.addValue

destroy

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

Returns Promise<void>
Implementation of PDFDictionaryType.destroy

getArray

getArray(key: string): Promise<null | PDFArrayType>
获取由键指定的数组对象。
Parameters
- key: string
  输入的键字符串。
Returns Promise<null | PDFArrayType>
返回由键指定的数组对象。

Implementation of PDFDictionaryType.getArray

getBoolean

getBoolean(key: string, defaultBool?: boolean): Promise<boolean>
获取由 key 指定的元素的布尔值。
Parameters
- key: string
  输入的键字符串。
- defaultBool: boolean = false
  默认布尔值。默认值为 false。
Returns Promise<boolean>
返回由 key 指定元素的布尔值。

Implementation of PDFDictionaryType.getBoolean

getCount

getCount(): Promise<number>
获取字典中的元素数量。

Returns Promise<number>
返回字典中的元素数量。

Implementation of PDFDictionaryType.getCount

getDict

getDict(key: string): Promise<null | PDFDictionaryType>
根据指定的键获取字典对象。
Parameters
- key: string
  输入的键字符串。
Returns Promise<null | PDFDictionaryType>
返回由键指定的字典对象。

Implementation of PDFDictionaryType.getDict

getElement

getElement(key: string): Promise<null | PDFObjectType>
获取元素的引用。返回对该元素的直接引用。
Parameters
- key: string
  输入的键字符串。
Returns Promise<null | PDFObjectType>
返回 PDFDictionary 实例中指定键对应的元素。

Implementation of PDFDictionaryType.getElement

getElementValue

getElementValue(key: string): Promise<null | PDFObjectType>
返回直接对象或被引用的间接对象。
Parameters
- key: string
  输入的键字符串。
Returns Promise<null | PDFObjectType>
返回直接对象或被引用的间接对象。

Implementation of PDFDictionaryType.getElementValue

getFloat

getFloat(key: string): Promise<number>
获取浮点数值。
Parameters
- key: string
  输入的键字符串。
Returns Promise<number>
返回由 key 指定元素的浮点数值。

Implementation of PDFDictionaryType.getFloat

getInteger

getInteger(key: string, defaultInt: number): Promise<number>
获取由键指定的元素的整数值。
Parameters
- key: string
  输入的键字符串。
- defaultInt: number
  默认的整数值。
Returns Promise<number>
返回由键指定的元素的整数值。

Implementation of PDFDictionaryType.getInteger

getInteger64

getInteger64(key: string): Promise<number>
获取由指定键对应元素的 64 位整数值。
Parameters
- key: string
  输入的键字符串。
Returns Promise<number>
返回由指定键对应元素的 64 位整数值。

Implementation of PDFDictionaryType.getInteger64

getMatrix

getMatrix(key: string): Promise<Matrix>
获取由指定键标识的元素的矩阵值。
Parameters
- key: string
  输入的键字符串。
Returns Promise<Matrix>
返回由指定键标识的元素的矩阵值。

Implementation of PDFDictionaryType.getMatrix

getName

getName(key: string): Promise<null | PDFObjectType>
获取由指定键对应的名称对象。
Parameters
- key: string
  输入的键字符串。
Returns Promise<null | PDFObjectType>
返回由指定键对应的名称对象。

Implementation of PDFDictionaryType.getName

getNumber

getNumber(key: string): Promise<number>
获取由指定键对应的元素的数值。
Parameters
- key: string
  输入的键字符串。
Returns Promise<number>
返回由指定键对应的元素的数值。

Implementation of PDFDictionaryType.getNumber

getRect

getRect(key: string): Promise<Rect>
获取由 key 指定的元素的矩形值。
Parameters
- key: string
  输入的键字符串。
Returns Promise<Rect>
返回由 key 指定的元素的矩形值。

Implementation of PDFDictionaryType.getRect

getStartPosition

getStartPosition(): Promise<null | POSITION>
获取间接对象的起始位置。

Returns Promise<null | POSITION>
返回间接对象的起始位置。

Implementation of PDFDictionaryType.getStartPosition

getString

getString(key: string): Promise<string>
获取由 key 指定的元素的字符串对象。
Parameters
- key: string
  输入的键字符串。
Returns Promise<string>
返回由 key 指定的元素的字符串对象。

Implementation of PDFDictionaryType.getString

getUnicodeText

getUnicodeText(key: string): Promise<string>
获取由 key 指定的元素的 Unicode 文本。
Parameters
- key: string
  输入的 key 字符串。
Returns Promise<string>
返回由 key 指定的元素的 Unicode 文本。

Implementation of PDFDictionaryType.getUnicodeText

isIdentical

isIdentical(otherDict: PDFDictionaryType): Promise<boolean>
将当前值与另一个对象进行比较。
Parameters
- otherDict: PDFDictionaryType
  要进行比较的对象。
Returns Promise<boolean>
如果两个对象相同则返回 true，否则返回 false。

Implementation of PDFDictionaryType.isIdentical

keyExist

keyExist(key: string): Promise<boolean>
检查字典中是否存在该键。
Parameters
- key: string
  输入的键字符串。
Returns Promise<boolean>
如果字典中存在该键则返回 true，否则返回 false。

Implementation of PDFDictionaryType.keyExist

removeAt

removeAt(key: string): Promise<void>
删除由键指定的元素。
Parameters
- key: string
  输入的键字符串。
Returns Promise<void>
Implementation of PDFDictionaryType.removeAt

replaceKey

replaceKey(oldKey: string, newKey: string): Promise<void>
将由 key 指定的元素的键替换为新的键字符串。
Parameters
- oldKey: string
  旧的键字符串。
- newKey: string
  新的键字符串。
Returns Promise<void>
Implementation of PDFDictionaryType.replaceKey

setAt

setAt(key: string, obj: PDFObjectType, doc: DocType): Promise<void>
设置元素数据。
Parameters
- key: string
  输入的键字符串。
- obj: PDFObjectType
  输入的元素数据，类型为 PDFObjectType。
- doc: DocType
  输入的文档对象。
Returns Promise<void>
Implementation of PDFDictionaryType.setAt

setAtBoolean

setAtBoolean(key: string, bool: boolean): Promise<void>
为由键指定的元素设置布尔对象的布尔值。
Parameters
- key: string
  输入的键字符串。
- bool: boolean
  布尔值。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtBoolean

setAtInteger

setAtInteger(key: string, num: number): Promise<void>
为指定键的元素设置一个 number 对象的 32 位整数值。
Parameters
- key: string
  输入的键字符串。
- num: number
  数值。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtInteger

setAtMatrix

setAtMatrix(key: string, matrix: Matrix): Promise<void>
为由 key 指定的元素设置矩阵对象。
Parameters
- key: string
  输入的键字符串。
- matrix: Matrix
  输入的矩阵对象。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtMatrix

setAtName

setAtName(key: string, name: string): Promise<void>
为指定键的元素设置名称对象字符串。
Parameters
- key: string
  输入的键字符串。
- name: string
  名称字符串。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtName

setAtNumber

setAtNumber(key: string, num: number): Promise<void>
为由键指定的元素设置一个数字对象。
Parameters
- key: string
  输入的键字符串。
- num: number
  数值。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtNumber

setAtRect

setAtRect(key: string, rect: Rect): Promise<void>
为由 key 指定的元素设置矩形区域。
Parameters
- key: string
  输入的键字符串。
- rect: Rect
  输入的矩形对象。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtRect

setAtReference2ToDoc

setAtReference2ToDoc(
    key: string,
    doc: DocType,
    obj: PDFObjectType,
): Promise<void>
为由键指定的元素设置引用对象。
Parameters
- key: string
  输入的键字符串。
- doc: DocType
  输入的文档对象。
- obj: PDFObjectType
  引用对象所指向的对象。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtReference2ToDoc

setAtReferenceToDoc

setAtReferenceToDoc(key: string, doc: DocType, objNum: number): Promise<void>
为由键指定的元素设置引用对象。
Parameters
- key: string
  输入的键字符串。
- doc: DocType
  输入的文档对象。
- objNum: number
  引用对象所对应的对象编号。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtReferenceToDoc

setAtString

setAtString(key: string, str: string): Promise<void>
为指定键的元素设置字符串或字符串对象。
Parameters
- key: string
  输入的键字符串。
- str: string
  字符串值。
Returns Promise<void>
Implementation of PDFDictionaryType.setAtString

setNewAt

setNewAt(key: string, objectType: number): Promise<null | PDFObjectType>
根据 object_type 分配并在指定位置设置对象元素。
Parameters
- key: string
  输入的键字符串。
- objectType: number
  对象类型。如下面所示：
  
  DefineConst.FPD_OBJ_INVALID
  
  DefineConst.FPD_OBJ_BOOLEAN
  
  DefineConst.FPD_OBJ_NUMBER
  
  DefineConst.FPD_OBJ_STRING
  
  DefineConst.FPD_OBJ_NAME
  
  DefineConst.FPD_OBJ_ARRAY
  
  DefineConst.FPD_OBJ_DICTIONARY
  
  DefineConst.FPD_OBJ_STREAM
  
  DefineConst.FPD_OBJ_NULL
  
  DefineConst.FPD_OBJ_REFERENCE
Returns Promise<null | PDFObjectType>
Implementation of PDFDictionaryType.setNewAt

`Static`create

create(options?: Options): Promise<PDFDictionaryType>
创建一个 PDFDictionary 实例。
Parameters
- Optionaloptions: Options
  用于创建 PDFDictionary 实例的选项。
Returns Promise<PDFDictionaryType>
返回一个 PDFDictionary 实例。