Class Form

constructor

• new Form(options: Options): Form

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

  Parameters

  • options: Options

    Create a Form instance with the specified options.

  Returns Form

  Example

   const form = await Form.create();
  Copy

options

calcBoundingBox

• calcBoundingBox(): Promise<Rect>

  Calculate the bounding box of the form.

  Returns Promise<Rect>

  Return the bounding box.

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

getCount

• getCount(): Promise<number>

  Get the count of the form.

  Returns Promise<number>

  Return the count of the form.

getDoc

• getDoc(): Promise<null | DocType>

  Get the doc of the form.

  Returns Promise<null | DocType>

  Return the doc.

getObjectByIndex

• getObjectByIndex(index: number): Promise<null | PageObjectType>

  Get the object by index.

  Parameters

  • index: number

    The index of the object.

  Returns Promise<null | PageObjectType>

  Return the object at the specified index.

getObjectIndex

• getObjectIndex(obj: PageObjectType): Promise<number>

  Get the index of the object in the form.

  Parameters

  • obj: PageObjectType

    The input PDF form object. The passed parameter is a certain pageObject within the current form, not a pageObject under other forms or peer pageObjects of the current form

  Returns Promise<number>

  Return the object index.

Staticcreate

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

  Create a Form instance.

  Parameters

  • Optionaloptions: Options

    Create a Form instance with the specified options.

  Returns Promise<FormType>

  Return a Form instance.

  Example

   const form = await Form.create();
  Copy