@adnsistemas/pdf-lib 1.18.0

package/ts3.4/cjs/api/form/PDFOptionList.d.ts

@@ -0,0 +1,336 @@
+import PDFDocument from "../PDFDocument";
+import PDFPage from "../PDFPage";
+import PDFFont from "../PDFFont";
+import PDFField, { FieldAppearanceOptions } from "./PDFField";
+import { AppearanceProviderFor } from "./appearances";
+import { PDFRef, PDFAcroListBox } from "../../core";
+/**
+ * Represents an option list field of a [[PDFForm]].
+ *
+ * [[PDFOptionList]] fields are interactive lists of options. The purpose of an
+ * option list is to enable users to select one or more options from a set of
+ * possible options. Users are able to see the full set of options without
+ * first having to click on the field (though scrolling may be necessary).
+ * Clicking an option in the list will cause it to be selected and displayed
+ * with a highlighted background. Some option lists allow users to select
+ * more than one option (see [[PDFOptionList.isMultiselect]]).
+ */
+export default class PDFOptionList extends PDFField {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFForm.getOptionList]] method, which will create
+     * > an instance of [[PDFOptionList]] for you.
+     *
+     * Create an instance of [[PDFOptionList]] from an existing acroListBox and
+     * ref
+     *
+     * @param acroComboBox The underlying `PDFAcroListBox` for this option list.
+     * @param ref The unique reference for this option list.
+     * @param doc The document to which this option list will belong.
+     */
+    static of: (acroListBox: PDFAcroListBox, ref: PDFRef, doc: PDFDocument) => PDFOptionList;
+    /** The low-level PDFAcroListBox wrapped by this option list. */
+    readonly acroField: PDFAcroListBox;
+    private constructor();
+    /**
+     * Get the list of available options for this option list. These options will
+     * be displayed to users who view this option list in a PDF reader.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * const options = optionList.getOptions()
+     * console.log('Option List options:', options)
+     * ```
+     * @returns The options for this option list.
+     */
+    getOptions(): string[];
+    /**
+     * Get the selected options for this option list. These are the values that
+     * were selected by a human user via a PDF reader, or programatically via
+     * software.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * const selections = optionList.getSelected()
+     * console.log('Option List selections:', selections)
+     * ```
+     * @returns The selected options for this option list.
+     */
+    getSelected(): string[];
+    /**
+     * Set the list of options that are available for this option list. These are
+     * the values that will be available for users to select when they view this
+     * option list in a PDF reader. Note that preexisting options for this
+     * option list will be removed. Only the values passed as `options` will be
+     * available to select.
+     *
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('planets.optionList')
+     * optionList.setOptions(['Earth', 'Mars', 'Pluto', 'Venus'])
+     * ```
+     *
+     * This method will mark this option list as dirty, causing its appearance
+     * streams to be updated when either [[PDFDocument.save]] or
+     * [[PDFForm.updateFieldAppearances]] is called. The updated streams will
+     * display the options this field contains inside the widgets of this text
+     * field (with selected options highlighted).
+     *
+     * **IMPORTANT:** The default font used to update appearance streams is
+     * [[StandardFonts.Helvetica]]. Note that this is a WinAnsi font. This means
+     * that encoding errors will be thrown if this field contains any options
+     * with characters outside the WinAnsi character set (the latin alphabet).
+     *
+     * Embedding a custom font and passing it to
+     * [[PDFForm.updateFieldAppearances]] or [[PDFOptionList.updateAppearances]]
+     * allows you to generate appearance streams with characters outside the
+     * latin alphabet (assuming the custom font supports them).
+     *
+     * @param options The options that should be available in this option list.
+     */
+    setOptions(options: string[]): void;
+    /**
+     * Add to the list of options that are available for this option list. Users
+     * will be able to select these values in a PDF reader. In addition to the
+     * values passed as `options`, any preexisting options for this option list
+     * will still be available for users to select.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('rockets.optionList')
+     * optionList.addOptions(['Saturn IV', 'Falcon Heavy'])
+     * ```
+     * This method will mark this option list as dirty. See
+     * [[PDFOptionList.setOptions]] for more details about what this means.
+     * @param options New options that should be available in this option list.
+     */
+    addOptions(options: string | string[]): void;
+    /**
+     * Select one or more values for this option list. This operation is analogous
+     * to a human user opening the option list in a PDF reader and clicking on one
+     * or more values to select them. This method will update the underlying state
+     * of the option list to indicate which values have been selected. PDF
+     * libraries and readers will be able to extract these values from the saved
+     * document and determine which values were selected.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('best.superheroes.optionList')
+     * optionList.select(['One Punch Man', 'Iron Man'])
+     * ```
+     * This method will mark this option list as dirty. See
+     * [[PDFOptionList.setOptions]] for more details about what this means.
+     * @param options The options to be selected.
+     * @param merge Whether or not existing selections should be preserved.
+     */
+    select(options: string | string[], merge?: boolean): void;
+    /**
+     * Clear all selected values for this option list. This operation is
+     * equivalent to selecting an empty list. This method will update the
+     * underlying state of the option list to indicate that no values have been
+     * selected.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.clear()
+     * ```
+     * This method will mark this option list as dirty. See
+     * [[PDFOptionList.setOptions]] for more details about what this means.
+     */
+    clear(): void;
+    /**
+     * Set the font size for the text in this field. There needs to be a
+     * default appearance string (DA) set with a font value specified
+     * for this to work. For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.setFontSize(4);
+     * ```
+     * @param fontSize The font size to set the font to.
+     */
+    /**
+     * Set the font size for this field. Larger font sizes will result in larger
+     * text being displayed when PDF readers render this option list. Font sizes
+     * may be integer or floating point numbers. Supplying a negative font size
+     * will cause this method to throw an error.
+     *
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.setFontSize(4)
+     * optionList.setFontSize(15.7)
+     * ```
+     *
+     * > This method depends upon the existence of a default appearance
+     * > (`/DA`) string. If this field does not have a default appearance string,
+     * > or that string does not contain a font size (via the `Tf` operator),
+     * > then this method will throw an error.
+     *
+     * @param fontSize The font size to be used when rendering text in this field.
+     */
+    setFontSize(fontSize: number): void;
+    /**
+     * Returns `true` if the options of this option list are always displayed
+     * in alphabetical order, irrespective of the order in which the options
+     * were added to the option list. See [[PDFOptionList.enableSorting]] and
+     * [[PDFOptionList.disableSorting]]. For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * if (optionList.isSorted()) console.log('Sorting is enabled')
+     * ```
+     * @returns Whether or not this option list is sorted.
+     */
+    isSorted(): boolean;
+    /**
+     * Always display the options of this option list in alphabetical order,
+     * irrespective of the order in which the options were added to this option
+     * list.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.enableSorting()
+     * ```
+     */
+    enableSorting(): void;
+    /**
+     * Do not always display the options of this option list in alphabetical
+     * order. Instead, display the options in whichever order they were added
+     * to this option list. For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.disableSorting()
+     * ```
+     */
+    disableSorting(): void;
+    /**
+     * Returns `true` if multiple options can be selected from this option list.
+     * See [[PDFOptionList.enableMultiselect]] and
+     * [[PDFOptionList.disableMultiselect]]. For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * if (optionList.isMultiselect()) console.log('Multiselect is enabled')
+     * ```
+     * @returns Whether or not multiple options can be selected.
+     */
+    isMultiselect(): boolean;
+    /**
+     * Allow users to select more than one option from this option list.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.enableMultiselect()
+     * ```
+     */
+    enableMultiselect(): void;
+    /**
+     * Do not allow users to select more than one option from this option list.
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.disableMultiselect()
+     * ```
+     */
+    disableMultiselect(): void;
+    /**
+     * Returns `true` if the option selected by a user is stored, or "committed",
+     * when the user clicks the option. The alternative is that the user's
+     * selection is stored when the user leaves this option list field (by
+     * clicking outside of it - on another field, for example). See
+     * [[PDFOptionList.enableSelectOnClick]] and
+     * [[PDFOptionList.disableSelectOnClick]]. For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * if (optionList.isSelectOnClick()) console.log('Select on click is enabled')
+     * ```
+     * @returns Whether or not options are selected immediately after they are
+     *          clicked.
+     */
+    isSelectOnClick(): boolean;
+    /**
+     * Store the option selected by a user immediately after the user clicks the
+     * option. Do not wait for the user to leave this option list field (by
+     * clicking outside of it - on another field, for example). For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.enableSelectOnClick()
+     * ```
+     */
+    enableSelectOnClick(): void;
+    /**
+     * Wait to store the option selected by a user until they leave this option
+     * list field (by clicking outside of it - on another field, for example).
+     * For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.disableSelectOnClick()
+     * ```
+     */
+    disableSelectOnClick(): void;
+    /**
+     * Show this option list on the specified page. For example:
+     * ```js
+     * const ubuntuFont = await pdfDoc.embedFont(ubuntuFontBytes)
+     * const page = pdfDoc.addPage()
+     *
+     * const form = pdfDoc.getForm()
+     * const optionList = form.createOptionList('best.gundams')
+     * optionList.setOptions(['Exia', 'Dynames', 'Kyrios', 'Virtue'])
+     * optionList.select(['Exia', 'Virtue'])
+     *
+     * optionList.addToPage(page, {
+     *   x: 50,
+     *   y: 75,
+     *   width: 200,
+     *   height: 100,
+     *   textColor: rgb(1, 0, 0),
+     *   backgroundColor: rgb(0, 1, 0),
+     *   borderColor: rgb(0, 0, 1),
+     *   borderWidth: 2,
+     *   rotate: degrees(90),
+     *   font: ubuntuFont,
+     * })
+     * ```
+     * This will create a new widget for this option list field.
+     * @param page The page to which this option list widget should be added.
+     * @param options The options to be used when adding this option list widget.
+     */
+    addToPage(page: PDFPage, options?: FieldAppearanceOptions): void;
+    /**
+     * Returns `true` if this option list has been marked as dirty, or if any of
+     * this option list's widgets do not have an appearance stream. For example:
+     * ```js
+     * const optionList = form.getOptionList('some.optionList.field')
+     * if (optionList.needsAppearancesUpdate()) console.log('Needs update')
+     * ```
+     * @returns Whether or not this option list needs an appearance update.
+     */
+    needsAppearancesUpdate(): boolean;
+    /**
+     * Update the appearance streams for each of this option list's widgets using
+     * the default appearance provider for option lists. For example:
+     * ```js
+     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.defaultUpdateAppearances(helvetica)
+     * ```
+     * @param font The font to be used for creating the appearance streams.
+     */
+    defaultUpdateAppearances(font: PDFFont): void;
+    /**
+     * Update the appearance streams for each of this option list's widgets using
+     * the given appearance provider. If no `provider` is passed, the default
+     * appearance provider for option lists will be used. For example:
+     * ```js
+     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
+     * const optionList = form.getOptionList('some.optionList.field')
+     * optionList.updateAppearances(helvetica, (field, widget, font) => {
+     *   ...
+     *   return drawOptionList(...)
+     * })
+     * ```
+     * @param font The font to be used for creating the appearance streams.
+     * @param provider Optionally, the appearance provider to be used for
+     *                 generating the contents of the appearance streams.
+     */
+    updateAppearances(font: PDFFont, provider?: AppearanceProviderFor<PDFOptionList>): void;
+    private updateWidgetAppearance;
+}
+//# sourceMappingURL=PDFOptionList.d.ts.map

package/ts3.4/cjs/api/form/PDFRadioGroup.d.ts

@@ -0,0 +1,253 @@
+import PDFDocument from "../PDFDocument";
+import PDFPage from "../PDFPage";
+import PDFField, { FieldAppearanceOptions } from "./PDFField";
+import { AppearanceProviderFor } from "./appearances";
+import { PDFRef, PDFAcroRadioButton } from "../../core";
+/**
+ * Represents a radio group field of a [[PDFForm]].
+ *
+ * [[PDFRadioGroup]] fields are collections of radio buttons. The purpose of a
+ * radio group is to enable users to select one option from a set of mutually
+ * exclusive choices. Each choice in a radio group is represented by a radio
+ * button. Radio buttons each have two states: `on` and `off`. At most one
+ * radio button in a group may be in the `on` state at any time. Users can
+ * click on a radio button to select it (and thereby automatically deselect any
+ * other radio button that might have already been selected). Some radio
+ * groups allow users to toggle a selected radio button `off` by clicking on
+ * it (see [[PDFRadioGroup.isOffToggleable]]).
+ *
+ * Note that some radio groups allow multiple radio buttons to be in the `on`
+ * state at the same type **if** they represent the same underlying value (see
+ * [[PDFRadioGroup.isMutuallyExclusive]]).
+ */
+export default class PDFRadioGroup extends PDFField {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFForm.getOptionList]] method, which will create an
+     * > instance of [[PDFOptionList]] for you.
+     *
+     * Create an instance of [[PDFOptionList]] from an existing acroRadioButton
+     * and ref
+     *
+     * @param acroRadioButton The underlying `PDFAcroRadioButton` for this
+     *                        radio group.
+     * @param ref The unique reference for this radio group.
+     * @param doc The document to which this radio group will belong.
+     */
+    static of: (acroRadioButton: PDFAcroRadioButton, ref: PDFRef, doc: PDFDocument) => PDFRadioGroup;
+    /** The low-level PDFAcroRadioButton wrapped by this radio group. */
+    readonly acroField: PDFAcroRadioButton;
+    private constructor();
+    /**
+     * Get the list of available options for this radio group. Each option is
+     * represented by a radio button. These radio buttons are displayed at
+     * various locations in the document, potentially on different pages (though
+     * typically they are stacked horizontally or vertically on the same page).
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * const options = radioGroup.getOptions()
+     * console.log('Radio Group options:', options)
+     * ```
+     * @returns The options for this radio group.
+     */
+    getOptions(): string[];
+    /**
+     * Get the selected option for this radio group. The selected option is
+     * represented by the radio button in this group that is turned on. At most
+     * one radio button in a group can be selected. If no buttons in this group
+     * are selected, `undefined` is returned.
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * const selected = radioGroup.getSelected()
+     * console.log('Selected radio button:', selected)
+     * ```
+     * @returns The selected option for this radio group.
+     */
+    getSelected(): string | undefined;
+    /**
+     * Select an option for this radio group. This operation is analogous to a
+     * human user clicking one of the radio buttons in this group via a PDF
+     * reader to toggle it on. This method will update the underlying state of
+     * the radio group to indicate which option has been selected. PDF libraries
+     * and readers will be able to extract this value from the saved document and
+     * determine which option was selected.
+     *
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('best.superhero.radioGroup')
+     * radioGroup.select('One Punch Man')
+     * ```
+     *
+     * This method will mark this radio group as dirty, causing its appearance
+     * streams to be updated when either [[PDFDocument.save]] or
+     * [[PDFForm.updateFieldAppearances]] is called. The updated appearance
+     * streams will display a dot inside the widget of this check box field
+     * that represents the selected option.
+     *
+     * @param option The option to be selected.
+     */
+    select(option: string): void;
+    /**
+     * Clear any selected option for this dropdown. This will result in all
+     * radio buttons in this group being toggled off. This method will update
+     * the underlying state of the dropdown to indicate that no radio buttons
+     * have been selected.
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.clear()
+     * ```
+     * This method will mark this radio group as dirty. See
+     * [[PDFRadioGroup.select]] for more details about what this means.
+     */
+    clear(): void;
+    /**
+     * Returns `true` if users can click on radio buttons in this group to toggle
+     * them off. The alternative is that once a user clicks on a radio button
+     * to select it, the only way to deselect it is by selecting on another radio
+     * button in the group. See [[PDFRadioGroup.enableOffToggling]] and
+     * [[PDFRadioGroup.disableOffToggling]]. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * if (radioGroup.isOffToggleable()) console.log('Off toggling is enabled')
+     * ```
+     */
+    isOffToggleable(): boolean;
+    /**
+     * Allow users to click on selected radio buttons in this group to toggle
+     * them off. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.enableOffToggling()
+     * ```
+     * > **NOTE:** This feature is documented in the PDF specification
+     * > (Table 226). However, most PDF readers do not respect this option and
+     * > prevent users from toggling radio buttons off even when it is enabled.
+     * > At the time of this writing (9/6/2020) Mac's Preview software did
+     * > respect the option. Adobe Acrobat, Foxit Reader, and Google Chrome did
+     * > not.
+     */
+    enableOffToggling(): void;
+    /**
+     * Prevent users from clicking on selected radio buttons in this group to
+     * toggle them off. Clicking on a selected radio button will have no effect.
+     * The only way to deselect a selected radio button is to click on a
+     * different radio button in the group. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.disableOffToggling()
+     * ```
+     */
+    disableOffToggling(): void;
+    /**
+     * Returns `true` if the radio buttons in this group are mutually exclusive.
+     * This means that when the user selects a radio button, only that specific
+     * button will be turned on. Even if other radio buttons in the group
+     * represent the same value, they will not be enabled. The alternative to
+     * this is that clicking a radio button will select that button along with
+     * any other radio buttons in the group that share the same value. See
+     * [[PDFRadioGroup.enableMutualExclusion]] and
+     * [[PDFRadioGroup.disableMutualExclusion]].
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * if (radioGroup.isMutuallyExclusive()) console.log('Mutual exclusion is enabled')
+     * ```
+     */
+    isMutuallyExclusive(): boolean;
+    /**
+     * When the user clicks a radio button in this group it will be selected. In
+     * addition, any other radio buttons in this group that share the same
+     * underlying value will also be selected. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.enableMutualExclusion()
+     * ```
+     * Note that this option must be enabled prior to adding options to the
+     * radio group. It does not currently apply retroactively to existing
+     * radio buttons in the group.
+     */
+    enableMutualExclusion(): void;
+    /**
+     * When the user clicks a radio button in this group only it will be selected.
+     * No other radio buttons in the group will be selected, even if they share
+     * the same underlying value. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.disableMutualExclusion()
+     * ```
+     * Note that this option must be disabled prior to adding options to the
+     * radio group. It does not currently apply retroactively to existing
+     * radio buttons in the group.
+     */
+    disableMutualExclusion(): void;
+    /**
+     * Add a new radio button to this group on the specified page. For example:
+     * ```js
+     * const page = pdfDoc.addPage()
+     *
+     * const form = pdfDoc.getForm()
+     * const radioGroup = form.createRadioGroup('best.gundam')
+     *
+     * const options = {
+     *   x: 50,
+     *   width: 25,
+     *   height: 25,
+     *   textColor: rgb(1, 0, 0),
+     *   backgroundColor: rgb(0, 1, 0),
+     *   borderColor: rgb(0, 0, 1),
+     *   borderWidth: 2,
+     *   rotate: degrees(90),
+     * }
+     *
+     * radioGroup.addOptionToPage('Exia', page, { ...options, y: 50 })
+     * radioGroup.addOptionToPage('Dynames', page, { ...options, y: 110 })
+     * ```
+     * This will create a new radio button widget for this radio group field.
+     * @param option The option that the radio button widget represents.
+     * @param page The page to which the radio button widget should be added.
+     * @param options The options to be used when adding the radio button widget.
+     */
+    addOptionToPage(option: string, page: PDFPage, options?: FieldAppearanceOptions): void;
+    /**
+     * Returns `true` if any of this group's radio button widgets do not have an
+     * appearance stream for their current state. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * if (radioGroup.needsAppearancesUpdate()) console.log('Needs update')
+     * ```
+     * @returns Whether or not this radio group needs an appearance update.
+     */
+    needsAppearancesUpdate(): boolean;
+    /**
+     * Update the appearance streams for each of this group's radio button widgets
+     * using the default appearance provider for radio groups. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.defaultUpdateAppearances()
+     * ```
+     */
+    defaultUpdateAppearances(): void;
+    /**
+     * Update the appearance streams for each of this group's radio button widgets
+     * using the given appearance provider. If no `provider` is passed, the
+     * default appearance provider for radio groups will be used. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.updateAppearances((field, widget) => {
+     *   ...
+     *   return {
+     *     normal: { on: drawRadioButton(...), off: drawRadioButton(...) },
+     *     down: { on: drawRadioButton(...), off: drawRadioButton(...) },
+     *   }
+     * })
+     * ```
+     * @param provider Optionally, the appearance provider to be used for
+     *                 generating the contents of the appearance streams.
+     */
+    updateAppearances(provider?: AppearanceProviderFor<PDFRadioGroup>): void;
+    private updateWidgetAppearance;
+}
+//# sourceMappingURL=PDFRadioGroup.d.ts.map

package/ts3.4/cjs/api/form/PDFSignature.d.ts

@@ -0,0 +1,30 @@
+import PDFDocument from "../PDFDocument";
+import PDFField from "./PDFField";
+import { PDFRef, PDFAcroSignature } from "../../core";
+/**
+ * Represents a signature field of a [[PDFForm]].
+ *
+ * [[PDFSignature]] fields are digital signatures. `pdf-lib` does not
+ * currently provide any specialized APIs for creating digital signatures or
+ * reading the contents of existing digital signatures.
+ */
+export default class PDFSignature extends PDFField {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFForm.getSignature]] method, which will create an
+     * > instance of [[PDFSignature]] for you.
+     *
+     * Create an instance of [[PDFSignature]] from an existing acroSignature and
+     * ref
+     *
+     * @param acroSignature The underlying `PDFAcroSignature` for this signature.
+     * @param ref The unique reference for this signature.
+     * @param doc The document to which this signature will belong.
+     */
+    static of: (acroSignature: PDFAcroSignature, ref: PDFRef, doc: PDFDocument) => PDFSignature;
+    /** The low-level PDFAcroSignature wrapped by this signature. */
+    readonly acroField: PDFAcroSignature;
+    private constructor();
+    needsAppearancesUpdate(): boolean;
+}
+//# sourceMappingURL=PDFSignature.d.ts.map