Class PDFDictionary

constructor

• new PDFDictionary(options?: Options): PDFDictionary

  Create a PDFDictionary instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a PDFDictionary instance with the specified options.

  Returns PDFDictionary

  Example

  const pdfDictionary = await PDFDictionary.create();
  Copy

options

addReference

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

  Add a reference object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • doc: DocType

    The input document object.
  • objNum: number

    The referred object number for the reference object.

  Returns Promise<void>

addValue

• addValue(key: string, obj: AddValueObjType): Promise<void>

  Add a new key-value pair to the dictionary.

  Parameters

  • key: string

    The input key string.
  • obj: AddValueObjType

    The input value object.

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

getArray

• getArray(key: string): Promise<null | PDFArrayType>

  Get an array object specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<null | PDFArrayType>

  Return an array object specified by key.

getBoolean

• getBoolean(key: string, defaultBool?: boolean): Promise<boolean>

  Get the boolean value for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • defaultBool: boolean = false

    The default boolean value. Default is false.

  Returns Promise<boolean>

  Return the boolean value for the element specified by key.

getCount

• getCount(): Promise<number>

  Get the number of elements in the dictionary.

  Returns Promise<number>

  Return the number of elements in the dictionary.

getDict

• getDict(key: string): Promise<null | PDFDictionaryType>

  Get a dictionary object specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<null | PDFDictionaryType>

  Return a dictionary object specified by key.

getElement

• getElement(key: string): Promise<null | PDFObjectType>

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

  Parameters

  • key: string

    The input key string.

  Returns Promise<null | PDFObjectType>

  Return the element at the specified key in the PDFDictionary instance.

getElementValue

• getElementValue(key: string): Promise<null | PDFObjectType>

  Returns direct or referred indirect object.

  Parameters

  • key: string

    The input key string.

  Returns Promise<null | PDFObjectType>

  Returns direct or referred indirect object.

getFloat

• getFloat(key: string): Promise<number>

  Get float value.

  Parameters

  • key: string

    The input key string.

  Returns Promise<number>

  Return the float value for the element specified by key.

getInteger

• getInteger(key: string, defaultInt: number): Promise<number>

  Get the integer value for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • defaultInt: number

    The default integer value.

  Returns Promise<number>

  Return the integer value for the element specified by key.

getInteger64

• getInteger64(key: string): Promise<number>

  Get the 64-bit integer value for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<number>

  Return the 64-bit integer value for the element specified by key.

getMatrix

• getMatrix(key: string): Promise<Matrix>

  Get the matrix value for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<Matrix>

  Return the matrix value for the element specified by key.

getName

• getName(key: string): Promise<null | PDFObjectType>

  Get the name object for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<null | PDFObjectType>

  Return the name object for the element specified by key.

getNumber

• getNumber(key: string): Promise<number>

  Get the number value for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<number>

  Return the number value for the element specified by key.

getRect

• getRect(key: string): Promise<Rect>

  Get the rectangle value for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<Rect>

  Return the rectangle value for the element specified by key.

getStartPosition

• getStartPosition(): Promise<null | POSITION>

  Get the start position of the indirect objects.

  Returns Promise<null | POSITION>

  Return the start position of the indirect objects.

getString

• getString(key: string): Promise<string>

  Get the string object for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<string>

  Return the string object for the element specified by key.

getUnicodeText

• getUnicodeText(key: string): Promise<string>

  Get the unicode text for the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<string>

  Return the unicode text for the element specified by key.

isIdentical

• isIdentical(otherDict: PDFDictionaryType): Promise<boolean>

  Compare value with another object.

  Parameters

  • otherDict: PDFDictionaryType

    The object to compare with.

  Returns Promise<boolean>

  Return true if the two objects are the same, otherwise return false.

keyExist

• keyExist(key: string): Promise<boolean>

  Check if the key exists in the dictionary.

  Parameters

  • key: string

    The input key string.

  Returns Promise<boolean>

  Return true if the key exists in the dictionary, otherwise return false.

removeAt

• removeAt(key: string): Promise<void>

  Remove the element specified by key.

  Parameters

  • key: string

    The input key string.

  Returns Promise<void>

replaceKey

• replaceKey(oldKey: string, newKey: string): Promise<void>

  Replace the key of the element specified by key with new key string.

  Parameters

  • oldKey: string

    The old key string.
  • newKey: string

    The new key string.

  Returns Promise<void>

setAt

• setAt(key: string, obj: PDFObjectType, doc: DocType): Promise<void>

  Setting element data.

  Parameters

  • key: string

    The input key string.
  • obj: PDFObjectType

    The input element data.，type is PDFObjectType。
  • doc: DocType

    The input document object.

  Returns Promise<void>

setAtBoolean

• setAtBoolean(key: string, bool: boolean): Promise<void>

  Set a boolean value of boolean object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • bool: boolean

    The boolean value.

  Returns Promise<void>

setAtInteger

• setAtInteger(key: string, num: number): Promise<void>

  Set a 32-bit integer of number object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • num: number

    The number value.

  Returns Promise<void>

setAtMatrix

• setAtMatrix(key: string, matrix: Matrix): Promise<void>

  Set a matrix object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • matrix: Matrix

    The input matrix object.

  Returns Promise<void>

setAtName

• setAtName(key: string, name: string): Promise<void>

  Set a string of name object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • name: string

    The name string.

  Returns Promise<void>

setAtNumber

• setAtNumber(key: string, num: number): Promise<void>

  Set a number object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • num: number

    The number value.

  Returns Promise<void>

setAtRect

• setAtRect(key: string, rect: Rect): Promise<void>

  Set a rectangle for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • rect: Rect

    The input rectangle object.

  Returns Promise<void>

setAtReference2ToDoc

• setAtReference2ToDoc(
      key: string,
      doc: DocType,
      obj: PDFObjectType,
  ): Promise<void>

  Set a reference object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • doc: DocType

    The input document object.
  • obj: PDFObjectType

    The referred object for the reference object.

  Returns Promise<void>

setAtReferenceToDoc

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

  Set a reference object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • doc: DocType

    The input document object.
  • objNum: number

    The referred object number for the reference object.

  Returns Promise<void>

setAtString

• setAtString(key: string, str: string): Promise<void>

  Set a string of string object for the element specified by key.

  Parameters

  • key: string

    The input key string.
  • str: string

    The string value.

  Returns Promise<void>

setNewAt

• setNewAt(key: string, objectType: number): Promise<null | PDFObjectType>

  Allocate by object_type and set object element at specified position.

  Parameters

  • key: string

    The input key string.
  • objectType: number

    The object type. Like below:

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

Staticcreate

• create(options?: Options): Promise<PDFDictionaryType>

  Create a PDFDictionary instance.

  Parameters

  • Optionaloptions: Options

    The options to create a PDFDictionary instance.

  Returns Promise<PDFDictionaryType>

  Return a PDFDictionary instance.