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>

  计算表单的边界框。

  Returns Promise<Rect>

  返回边界框。

destroy

• destroy(): Promise<void>

  销毁当前对象。

  Returns Promise<void>

getCount

• getCount(): Promise<number>

  获取表单的数量。

  Returns Promise<number>

  返回表单的数量。

getDoc

• getDoc(): Promise<null | DocType>

  获取表单的文档。

  Returns Promise<null | DocType>

  返回文档。

getObjectByIndex

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

  通过索引获取对象。

  Parameters

  • index: number

    对象的索引。

  Returns Promise<null | PageObjectType>

  返回指定索引处的对象。

getObjectIndex

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

  获取对象在表单中的索引。

  Parameters

  • obj: PageObjectType

    输入的 PDF 表单对象。传入的参数是当前表单中的某个 pageObject，而不是其他表单下的 pageObject 或当前表单中与其同级的 pageObject

  Returns Promise<number>

  返回对象索引。

Staticcreate

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

  创建一个 Form 实例。

  Parameters

  • Optionaloptions: Options

    使用指定的选项创建一个 Form 实例。

  Returns Promise<FormType>

  返回一个 Form 实例。

  Example

   const form = await Form.create();
  Copy