Interface PDFArrayType

interface PDFArrayType {
    add: (otherObj: PDFObjectType, doc: DocType) => Promise<void>;
    addInteger: (value: number) => Promise<void>;
    addName: (name: string) => Promise<void>;
    addNew: (
        obj: PDFObjectType,
        pdfObjectType: number,
    ) => Promise<null | PDFObjectType>;
    addNumber: (num: number) => Promise<void>;
    addReference2ToDoc: (doc: DocType, obj: PDFObjectType) => Promise<void>;
    addReferenceToDoc: (doc: DocType, objNum: number) => Promise<void>;
    addString: (str: string) => Promise<void>;
    destroy: () => Promise<void>;
    getArray: (index: number) => Promise<null | PDFObjectType>;
    getCount: () => Promise<number>;
    getDict: (index: number) => Promise<null | PDFDictionaryType>;
    getElement: (index: number) => Promise<null | PDFObjectType>;
    getElementValue: (index: number) => Promise<null | PDFObjectType>;
    getFloat: (index: number) => Promise<number>;
    getInteger: (index: number) => Promise<number>;
    getMatrix: () => Promise<Matrix>;
    getNumber: (index: number) => Promise<number>;
    getRect: () => Promise<Rect>;
    getStream: (index: number) => Promise<null | PDFObjectType>;
    getString: (index: number) => Promise<string>;
    insertAt: (insertAt: InsertAtType) => Promise<void>;
    isIdentical: (otherArr: PDFArrayType) => Promise<boolean>;
    options?: Options;
    release: () => Promise<void>;
    removeAt: (index: number) => Promise<void>;
}

Implemented by

Properties

add addInteger addName addNew addNumber addReference2ToDoc addReferenceToDoc addString destroy getArray getCount getDict getElement getElementValue getFloat getInteger getMatrix getNumber getRect getStream getString insertAt isIdentical options? release removeAt

Properties

add

add: (otherObj: PDFObjectType, doc: DocType) => Promise<void>

添加元素。

Type declaration

addInteger

addInteger: (value: number) => Promise<void>

向 PDFArray 实例添加一个整数。

Type declaration

    • (value: number): Promise<void>

    • Parameters

      • value: number

        要添加的整数。

      Returns Promise<void>

addName

addName: (name: string) => Promise<void>

添加一个名称对象。

Type declaration

    • (name: string): Promise<void>

    • Parameters

      • name: string

        要添加的名称。

      Returns Promise<void>

addNew

addNew: (
    obj: PDFObjectType,
    pdfObjectType: number,
) => Promise<null | PDFObjectType>

通过 object_type 添加一个对象元素。

Type declaration

addNumber

addNumber: (num: number) => Promise<void>

向 PDFArray 实例添加一个数字。

Type declaration

    • (num: number): Promise<void>

    • Parameters

      • num: number

        要添加的数字。

      Returns Promise<void>

addReference2ToDoc

addReference2ToDoc: (doc: DocType, obj: PDFObjectType) => Promise<void>

使用对象添加一个引用对象。

Type declaration

addReferenceToDoc

addReferenceToDoc: (doc: DocType, objNum: number) => Promise<void>

添加带有对象编号的引用对象。

Type declaration

    • (doc: DocType, objNum: number): Promise<void>

    • Parameters

      • doc: DocType

        文档对象。

      • objNum: number

        被引用的对象编号。

      Returns Promise<void>

addString

addString: (str: string) => Promise<void>

添加一个字符串对象。

Type declaration

    • (str: string): Promise<void>

    • Parameters

      • str: string

        要添加的字符串。

      Returns Promise<void>

destroy

destroy: () => Promise<void>

销毁当前对象。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getArray

getArray: (index: number) => Promise<null | PDFObjectType>

获取指定位置的数组对象。

Type declaration

    • (index: number): Promise<null | PDFObjectType>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<null | PDFObjectType>

      返回指定位置的数组对象。

getCount

getCount: () => Promise<number>

获取 PDFArray 实例中的元素数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回 PDFArray 实例中的元素数量。

getDict

getDict: (index: number) => Promise<null | PDFDictionaryType>

获取指定位置的字典对象。

Type declaration

    • (index: number): Promise<null | PDFDictionaryType>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<null | PDFDictionaryType>

      返回指定位置的字典对象。

getElement

getElement: (index: number) => Promise<null | PDFObjectType>

获取元素的引用。返回对该元素的直接引用。

Type declaration

    • (index: number): Promise<null | PDFObjectType>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<null | PDFObjectType>

      返回 PDFArray 实例中指定索引处的元素。

getElementValue

getElementValue: (index: number) => Promise<null | PDFObjectType>

获取 PDFArray 实例中指定索引处的直接对象或被引用的间接对象。

Type declaration

    • (index: number): Promise<null | PDFObjectType>

    • Parameters

      • index: number

        指定数组中的从零开始的索引。

      Returns Promise<null | PDFObjectType>

      返回直接对象或被引用的间接对象。

getFloat

getFloat: (index: number) => Promise<number>

获取指定位置的浮点数。

Type declaration

    • (index: number): Promise<number>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<number>

getInteger

getInteger: (index: number) => Promise<number>

获取指定位置的整数。

Type declaration

    • (index: number): Promise<number>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<number>

      返回指定位置的整数。

getMatrix

getMatrix: () => Promise<Matrix>

获取 PDFArray 实例的矩阵。

Type declaration

    • (): Promise<Matrix>

    • Returns Promise<Matrix>

      返回 PDFArray 实例的矩阵。

getNumber

getNumber: (index: number) => Promise<number>

获取指定位置的数字。

Type declaration

    • (index: number): Promise<number>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<number>

      返回指定位置的数字。

getRect

getRect: () => Promise<Rect>

获取 PDFArray 实例的矩形。

Type declaration

    • (): Promise<Rect>

    • Returns Promise<Rect>

      返回 PDFArray 实例的矩形。

getStream

getStream: (index: number) => Promise<null | PDFObjectType>

获取指定位置的流对象。

Type declaration

    • (index: number): Promise<null | PDFObjectType>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<null | PDFObjectType>

      返回指定位置的流对象。

getString

getString: (index: number) => Promise<string>

获取指定位置的字符串。

Type declaration

    • (index: number): Promise<string>

    • Parameters

      • index: number

        指定数组中从零开始的索引。

      Returns Promise<string>

      返回指定位置的字符串。

insertAt

insertAt: (insertAt: InsertAtType) => Promise<void>

在指定位置插入一个元素。

Type declaration

isIdentical

isIdentical: (otherArr: PDFArrayType) => Promise<boolean>

与另一个对象进行比较。

Type declaration

Optionaloptions

options?: Options

release

release: () => Promise<void>

释放 FPDArray。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

removeAt

removeAt: (index: number) => Promise<void>

移除一个元素。

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        要移除的元素索引。

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties