Class FieldOptions

Parameters

• params: {
      fieldName: string;
      location?: FieldLocation;
      pageNumber?: number;
      visible?: boolean;
  }

  The parameters for constructing an instance of FieldOptions.

  • fieldName: string

    The name of the field to be used for applying the electronic seal. If signature field with this field name already exist, that field will be used. If it does not exist, a signature field with this field name will be created. Cannot be undefined.

  • Optional location?: FieldLocation

    A FieldLocation instance specifying coordinates for the electronic seal. The location is only required for visible signatures if the signature field does not already exist in the PDF document. If location is provided along with the existing signature field then it is ignored.

  • Optional pageNumber?: number

    The page number to which the signature field should be attached. Page numbers are 1-based. The page number is only required for visible signatures if the signature field does not already exist in the PDF document. If page number is provided along with the existing signature field then the page number should be same on which signature field is present in the document, else an error is thrown.

  • Optional visible?: boolean

    The intended visibility flag for the electronic seal. Default value is true.