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>

Adding element.

Type declaration

addInteger

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

Add an integer to the PDFArray instance.

Type declaration

    • (value: number): Promise<void>

    • Parameters

      • value: number

        The integer to be added.

      Returns Promise<void>

addName

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

Add a name object.

Type declaration

    • (name: string): Promise<void>

    • Parameters

      • name: string

        The name to be added.

      Returns Promise<void>

addNew

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

Add an object element by object_type.

Type declaration

addNumber

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

Add a number to the PDFArray instance.

Type declaration

    • (num: number): Promise<void>

    • Parameters

      • num: number

        The number to be added.

      Returns Promise<void>

addReference2ToDoc

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

Add a reference object with object.

Type declaration

addReferenceToDoc

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

Add a reference object with object number.

Type declaration

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

    • Parameters

      • doc: DocType

        The document object.

      • objNum: number

        The referred object number.

      Returns Promise<void>

addString

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

Add a string object.

Type declaration

    • (str: string): Promise<void>

    • Parameters

      • str: string

        The string to be added.

      Returns Promise<void>

destroy

destroy: () => Promise<void>

Destroy the current object.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getArray

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

Get an array object with specified position.

Type declaration

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

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<null | PDFObjectType>

      Return an array object with specified position.

getCount

getCount: () => Promise<number>

Get the number of elements in the PDFArray instance.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      Return the number of elements in the PDFArray instance.

getDict

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

Get a dictionary object with specified position.

Type declaration

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

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<null | PDFDictionaryType>

      Return a dictionary object with specified position.

getElement

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

Get reference to element. Returns direct reference to the element.

Type declaration

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

    • 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.

getElementValue

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

Get direct or referred indirect object at the specified index in the PDFArray instance.

Type declaration

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

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<null | PDFObjectType>

      Returns direct or referred indirect object.

getFloat

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

Get a floating-point with specified position.

Type declaration

    • (index: number): Promise<number>

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<number>

getInteger

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

Get an integer with specified position.

Type declaration

    • (index: number): Promise<number>

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<number>

      Return an integer with specified position.

getMatrix

getMatrix: () => Promise<Matrix>

Get the matrix of the PDFArray instance.

Type declaration

    • (): Promise<Matrix>

    • Returns Promise<Matrix>

      Return the matrix of the PDFArray instance.

getNumber

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

Get a number with specified position.

Type declaration

    • (index: number): Promise<number>

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<number>

      Return a number with specified position.

getRect

getRect: () => Promise<Rect>

Get the rectangle of the PDFArray instance.

Type declaration

    • (): Promise<Rect>

    • Returns Promise<Rect>

      Return the rectangle of the PDFArray instance.

getStream

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

Get a stream object with specified position.

Type declaration

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

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<null | PDFObjectType>

      Return a stream object with specified position.

getString

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

Get the string with specified position.

Type declaration

    • (index: number): Promise<string>

    • Parameters

      • index: number

        Specifies the zero-based index in the array.

      Returns Promise<string>

      Return the string with specified position.

insertAt

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

Insert an element at specified position.

Type declaration

isIdentical

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

Compare with another object.

Type declaration

    • (otherArr: PDFArrayType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

Optionaloptions

options?: Options

release

release: () => Promise<void>

Release the FPDArray.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

removeAt

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

Remove an element.

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        The index of the element to be removed.

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties