Class CPDFWidget

constructor

• new CPDFWidget(params: Partial<CPDFWidget>): CPDFWidget

  Parameters

  • params: Partial<CPDFWidget>

  Returns CPDFWidget

StaticfromJson

• fromJson<T extends CPDFWidget>(
      this: new (params: Partial<T>) => T,
      json: any,
  ): T

  Type Parameters

  • T extends CPDFWidget

  Parameters

  • this: new (params: Partial<T>) => T
  • json: any

  Returns T

StaticfromJsonArray

• fromJsonArray<T extends CPDFWidget>(
      this: new (params: Partial<T>) => T,
      jsonArray: any[],
  ): T[]

  Type Parameters

  • T extends CPDFWidget

  Parameters

  • this: new (params: Partial<T>) => T
  • jsonArray: any[]

  Returns T[]

StaticparseType

• parseType(type: any): CPDFWidgetType

  Parameters

  • type: any

  Returns CPDFWidgetType

toJSON

• toJSON(): Omit<CPDFWidget, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      borderColor: string;
      fillColor: string;
      borderWidth: number;
  }

  Returns Omit<CPDFWidget, "createDate" | "update" | "toJSON"> & {
      createDate?: number;
      borderColor: string;
      fillColor: string;
      borderWidth: number;
  }

update

• update(
      updates: Partial<Omit<this, "type" | "page" | "uuid" | "createDate">>,
  ): this

  Update widget properties in a type-safe way

  Parameters

  • updates: Partial<Omit<this, "type" | "page" | "uuid" | "createDate">>

    Partial object containing properties to update

  Returns this

  this instance for chaining

  Example

  widget.update({ title: 'New Title', fillColor: '#FF0000', borderColor: '#00FF00' });
  await document.updateWidget(widget);
  Copy

type

title

Readonlypage

Readonlyuuid

createDate

rect

borderColor

fillColor

borderWidth