@pdfme/pdf-lib 5.5.10-dev.13 → 5.5.10-dev.135

package/dist/node/src/api/form/PDFDropdown.js

@@ -1,617 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const PDFPage_1 = __importDefault(require("../PDFPage"));
-const PDFFont_1 = __importDefault(require("../PDFFont"));
-const PDFField_1 = __importStar(require("./PDFField"));
-const appearances_1 = require("./appearances");
-const colors_1 = require("../colors");
-const rotations_1 = require("../rotations");
-const core_1 = require("../../core");
-const utils_1 = require("../../utils");
-/**
- * Represents a dropdown field of a [[PDFForm]].
- *
- * [[PDFDropdown]] fields are interactive text boxes that display a single
- * element (the currently selected value). The purpose of a dropdown is to
- * enable users to select a single option from a set of possible options. Users
- * can click on a dropdown to view the full list of options it provides.
- * Clicking on an option in the list will cause it to be selected and displayed
- * in the dropdown's text box. Some dropdowns allow users to enter text
- * directly into the box from their keyboard, rather than only being allowed to
- * choose an option from the list (see [[PDFDropdown.isEditable]]).
- */
-class PDFDropdown extends PDFField_1.default {
-    constructor(acroComboBox, ref, doc) {
-        super(acroComboBox, ref, doc);
-        /** The low-level PDFAcroComboBox wrapped by this dropdown. */
-        Object.defineProperty(this, "acroField", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        (0, utils_1.assertIs)(acroComboBox, 'acroComboBox', [[core_1.PDFAcroComboBox, 'PDFAcroComboBox']]);
-        this.acroField = acroComboBox;
-    }
-    /**
-     * Get the list of available options for this dropdown. These options will be
-     * displayed to users who click on this dropdown in a PDF reader.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * const options = dropdown.getOptions()
-     * console.log('Dropdown options:', options)
-     * ```
-     * @returns The options for this dropdown.
-     */
-    getOptions() {
-        const rawOptions = this.acroField.getOptions();
-        const options = new Array(rawOptions.length);
-        for (let idx = 0, len = options.length; idx < len; idx++) {
-            const { display, value } = rawOptions[idx];
-            options[idx] = (display ?? value).decodeText();
-        }
-        return options;
-    }
-    /**
-     * Get the selected options for this dropdown. These are the values that were
-     * selected by a human user via a PDF reader, or programatically via
-     * software.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * const selections = dropdown.getSelected()
-     * console.log('Dropdown selections:', selections)
-     * ```
-     * > **NOTE:** Note that PDF readers only display one selected option when
-     * > rendering dropdowns. However, the PDF specification does allow for
-     * > multiple values to be selected in a dropdown. As such, the `pdf-lib`
-     * > API supports this. However, in most cases the array returned by this
-     * > method will contain only a single element (or no elements).
-     * @returns The selected options in this dropdown.
-     */
-    getSelected() {
-        const values = this.acroField.getValues();
-        const selected = new Array(values.length);
-        for (let idx = 0, len = values.length; idx < len; idx++) {
-            selected[idx] = values[idx].decodeText();
-        }
-        return selected;
-    }
-    /**
-     * Set the list of options that are available for this dropdown. These are
-     * the values that will be available for users to select when they view this
-     * dropdown in a PDF reader. Note that preexisting options for this dropdown
-     * will be removed. Only the values passed as `options` will be available to
-     * select.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('planets.dropdown')
-     * dropdown.setOptions(['Earth', 'Mars', 'Pluto', 'Venus'])
-     * ```
-     * @param options The options that should be available in this dropdown.
-     */
-    setOptions(options) {
-        (0, utils_1.assertIs)(options, 'options', [Array]);
-        const optionObjects = new Array(options.length);
-        for (let idx = 0, len = options.length; idx < len; idx++) {
-            optionObjects[idx] = { value: core_1.PDFHexString.fromText(options[idx]) };
-        }
-        this.acroField.setOptions(optionObjects);
-    }
-    /**
-     * Add to the list of options that are available for this dropdown. 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 dropdown will
-     * still be available for users to select.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('rockets.dropdown')
-     * dropdown.addOptions(['Saturn IV', 'Falcon Heavy'])
-     * ```
-     * @param options New options that should be available in this dropdown.
-     */
-    addOptions(options) {
-        (0, utils_1.assertIs)(options, 'options', ['string', Array]);
-        const optionsArr = Array.isArray(options) ? options : [options];
-        const existingOptions = this.acroField.getOptions();
-        const newOptions = new Array(optionsArr.length);
-        for (let idx = 0, len = optionsArr.length; idx < len; idx++) {
-            newOptions[idx] = { value: core_1.PDFHexString.fromText(optionsArr[idx]) };
-        }
-        this.acroField.setOptions(existingOptions.concat(newOptions));
-    }
-    /**
-     * Select one or more values for this dropdown. This operation is analogous
-     * to a human user opening the dropdown in a PDF reader and clicking on a
-     * value to select it. This method will update the underlying state of the
-     * dropdown 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 dropdown = form.getDropdown('best.superhero.dropdown')
-     * dropdown.select('One Punch Man')
-     * ```
-     *
-     * This method will mark this dropdown as dirty, causing its appearance
-     * streams to be updated when either [[PDFDocument.save]] or
-     * [[PDFForm.updateFieldAppearances]] is called. The updated streams will
-     * display the selected option inside the widgets of this dropdown.
-     *
-     * **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 the selected option for this field
-     * contains characters outside the WinAnsi character set (the latin alphabet).
-     *
-     * Embedding a custom font and passing it to
-     * [[PDFForm.updateFieldAppearances]] or [[PDFDropdown.updateAppearances]]
-     * allows you to generate appearance streams with characters outside the
-     * latin alphabet (assuming the custom font supports them).
-     *
-     * Selecting an option that does not exist in this dropdown's option list
-     * (see [[PDFDropdown.getOptions]]) will enable editing on this dropdown
-     * (see [[PDFDropdown.enableEditing]]).
-     *
-     * > **NOTE:** PDF readers only display one selected option when rendering
-     * > dropdowns. However, the PDF specification does allow for multiple values
-     * > to be selected in a dropdown. As such, the `pdf-lib` API supports this.
-     * > However, it is not recommended to select more than one value with this
-     * > method, as only one will be visible. [[PDFOptionList]] fields are better
-     * > suited for displaying multiple selected values.
-     *
-     * @param options The options to be selected.
-     * @param merge Whether or not existing selections should be preserved.
-     */
-    select(options, merge = false) {
-        (0, utils_1.assertIs)(options, 'options', ['string', Array]);
-        (0, utils_1.assertIs)(merge, 'merge', ['boolean']);
-        const optionsArr = Array.isArray(options) ? options : [options];
-        const validOptions = this.getOptions();
-        const hasCustomOption = optionsArr.find((option) => !validOptions.includes(option));
-        if (hasCustomOption)
-            this.enableEditing();
-        this.markAsDirty();
-        if (optionsArr.length > 1 || (optionsArr.length === 1 && merge)) {
-            this.enableMultiselect();
-        }
-        const values = new Array(optionsArr.length);
-        for (let idx = 0, len = optionsArr.length; idx < len; idx++) {
-            values[idx] = core_1.PDFHexString.fromText(optionsArr[idx]);
-        }
-        if (merge) {
-            const existingValues = this.acroField.getValues();
-            this.acroField.setValues(existingValues.concat(values));
-        }
-        else {
-            this.acroField.setValues(values);
-        }
-    }
-    /**
-     * Clear all selected values for this dropdown. This operation is equivalent
-     * to selecting an empty list. This method will update the underlying state
-     * of the dropdown to indicate that no values have been selected.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.clear()
-     * ```
-     * This method will mark this text field as dirty. See [[PDFDropdown.select]]
-     * for more details about what this means.
-     */
-    clear() {
-        this.markAsDirty();
-        this.acroField.setValues([]);
-    }
-    /**
-     * Set the font size for this field. Larger font sizes will result in larger
-     * text being displayed when PDF readers render this dropdown. 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 dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.setFontSize(4)
-     * dropdown.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) {
-        (0, utils_1.assertPositive)(fontSize, 'fontSize');
-        this.acroField.setFontSize(fontSize);
-        this.markAsDirty();
-    }
-    /**
-     * Returns `true` if users are allowed to edit the selected value of this
-     * dropdown directly and are not constrained by the list of available
-     * options. See [[PDFDropdown.enableEditing]] and
-     * [[PDFDropdown.disableEditing]]. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * if (dropdown.isEditable()) console.log('Editing is enabled')
-     * ```
-     * @returns Whether or not this dropdown is editable.
-     */
-    isEditable() {
-        return this.acroField.hasFlag(core_1.AcroChoiceFlags.Edit);
-    }
-    /**
-     * Allow users to edit the selected value of this dropdown in PDF readers
-     * with their keyboard. This means that the selected value of this dropdown
-     * will not be constrained by the list of available options. However, if this
-     * dropdown has any available options, users will still be allowed to select
-     * from that list.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.enableEditing()
-     * ```
-     */
-    enableEditing() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.Edit, true);
-    }
-    /**
-     * Do not allow users to edit the selected value of this dropdown in PDF
-     * readers with their keyboard. This will constrain the selected value of
-     * this dropdown to the list of available options. Users will only be able
-     * to select an option from that list.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.disableEditing()
-     * ```
-     */
-    disableEditing() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.Edit, false);
-    }
-    /**
-     * Returns `true` if the option list of this dropdown is always displayed
-     * in alphabetical order, irrespective of the order in which the options
-     * were added to the dropdown. See [[PDFDropdown.enableSorting]] and
-     * [[PDFDropdown.disableSorting]]. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * if (dropdown.isSorted()) console.log('Sorting is enabled')
-     * ```
-     * @returns Whether or not this dropdown's options are sorted.
-     */
-    isSorted() {
-        return this.acroField.hasFlag(core_1.AcroChoiceFlags.Sort);
-    }
-    /**
-     * Always display the option list of this dropdown in alphabetical order,
-     * irrespective of the order in which the options were added to this dropdown.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.enableSorting()
-     * ```
-     */
-    enableSorting() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.Sort, true);
-    }
-    /**
-     * Do not always display the option list of this dropdown in alphabetical
-     * order. Instead, display the options in whichever order they were added
-     * to the list. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.disableSorting()
-     * ```
-     */
-    disableSorting() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.Sort, false);
-    }
-    /**
-     * Returns `true` if multiple options can be selected from this dropdown's
-     * option list. See [[PDFDropdown.enableMultiselect]] and
-     * [[PDFDropdown.disableMultiselect]]. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * if (dropdown.isMultiselect()) console.log('Multiselect is enabled')
-     * ```
-     * @returns Whether or not multiple options can be selected.
-     */
-    isMultiselect() {
-        return this.acroField.hasFlag(core_1.AcroChoiceFlags.MultiSelect);
-    }
-    /**
-     * Allow users to select more than one option from this dropdown's option
-     * list. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.enableMultiselect()
-     * ```
-     */
-    enableMultiselect() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.MultiSelect, true);
-    }
-    /**
-     * Do not allow users to select more than one option from this dropdown's
-     * option list. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.disableMultiselect()
-     * ```
-     */
-    disableMultiselect() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.MultiSelect, false);
-    }
-    /**
-     * Returns `true` if the selected option should be spell checked by PDF
-     * readers. Spell checking will only be performed if this dropdown allows
-     * editing (see [[PDFDropdown.isEditable]]). See
-     * [[PDFDropdown.enableSpellChecking]] and
-     * [[PDFDropdown.disableSpellChecking]]. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * if (dropdown.isSpellChecked()) console.log('Spell checking is enabled')
-     * ```
-     * @returns Whether or not this dropdown can be spell checked.
-     */
-    isSpellChecked() {
-        return !this.acroField.hasFlag(core_1.AcroChoiceFlags.DoNotSpellCheck);
-    }
-    /**
-     * Allow PDF readers to spell check the selected option of this dropdown.
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.enableSpellChecking()
-     * ```
-     */
-    enableSpellChecking() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.DoNotSpellCheck, false);
-    }
-    /**
-     * Do not allow PDF readers to spell check the selected option of this
-     * dropdown. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.disableSpellChecking()
-     * ```
-     */
-    disableSpellChecking() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.DoNotSpellCheck, true);
-    }
-    /**
-     * 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 dropdown field (by clicking
-     * outside of it - on another field, for example). See
-     * [[PDFDropdown.enableSelectOnClick]] and
-     * [[PDFDropdown.disableSelectOnClick]]. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * if (dropdown.isSelectOnClick()) console.log('Select on click is enabled')
-     * ```
-     * @returns Whether or not options are selected immediately after they are
-     *          clicked.
-     */
-    isSelectOnClick() {
-        return this.acroField.hasFlag(core_1.AcroChoiceFlags.CommitOnSelChange);
-    }
-    /**
-     * Store the option selected by a user immediately after the user clicks the
-     * option. Do not wait for the user to leave this dropdown field (by clicking
-     * outside of it - on another field, for example). For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.enableSelectOnClick()
-     * ```
-     */
-    enableSelectOnClick() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.CommitOnSelChange, true);
-    }
-    /**
-     * Wait to store the option selected by a user until they leave this dropdown
-     * field (by clicking outside of it - on another field, for example).
-     * For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.disableSelectOnClick()
-     * ```
-     */
-    disableSelectOnClick() {
-        this.acroField.setFlagTo(core_1.AcroChoiceFlags.CommitOnSelChange, false);
-    }
-    /**
-     * Show this dropdown on the specified page. For example:
-     * ```js
-     * const ubuntuFont = await pdfDoc.embedFont(ubuntuFontBytes)
-     * const page = pdfDoc.addPage()
-     *
-     * const form = pdfDoc.getForm()
-     * const dropdown = form.createDropdown('best.gundam')
-     * dropdown.setOptions(['Exia', 'Dynames'])
-     * dropdown.select('Exia')
-     *
-     * dropdown.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 dropdown field.
-     * @param page The page to which this dropdown widget should be added.
-     * @param options The options to be used when adding this dropdown widget.
-     */
-    addToPage(page, options) {
-        (0, utils_1.assertIs)(page, 'page', [[PDFPage_1.default, 'PDFPage']]);
-        (0, PDFField_1.assertFieldAppearanceOptions)(options);
-        if (!options)
-            options = {};
-        if (!('textColor' in options))
-            options.textColor = (0, colors_1.rgb)(0, 0, 0);
-        if (!('backgroundColor' in options))
-            options.backgroundColor = (0, colors_1.rgb)(1, 1, 1);
-        if (!('borderColor' in options))
-            options.borderColor = (0, colors_1.rgb)(0, 0, 0);
-        if (!('borderWidth' in options))
-            options.borderWidth = 1;
-        // Create a widget for this dropdown
-        const widget = this.createWidget({
-            x: options.x ?? 0,
-            y: options.y ?? 0,
-            width: options.width ?? 200,
-            height: options.height ?? 50,
-            textColor: options.textColor,
-            backgroundColor: options.backgroundColor,
-            borderColor: options.borderColor,
-            borderWidth: options.borderWidth ?? 0,
-            rotate: options.rotate ?? (0, rotations_1.degrees)(0),
-            hidden: options.hidden,
-            page: page.ref,
-        });
-        const widgetRef = this.doc.context.register(widget.dict);
-        // Add widget to this field
-        this.acroField.addWidget(widgetRef);
-        // Set appearance streams for widget
-        const font = options.font ?? this.doc.getForm().getDefaultFont();
-        this.updateWidgetAppearance(widget, font);
-        // Add widget to the given page
-        page.node.addAnnot(widgetRef);
-    }
-    /**
-     * Returns `true` if this dropdown has been marked as dirty, or if any of
-     * this dropdown's widgets do not have an appearance stream. For example:
-     * ```js
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * if (dropdown.needsAppearancesUpdate()) console.log('Needs update')
-     * ```
-     * @returns Whether or not this dropdown needs an appearance update.
-     */
-    needsAppearancesUpdate() {
-        if (this.isDirty())
-            return true;
-        const widgets = this.acroField.getWidgets();
-        for (let idx = 0, len = widgets.length; idx < len; idx++) {
-            const widget = widgets[idx];
-            const hasAppearances = widget.getAppearances()?.normal instanceof core_1.PDFStream;
-            if (!hasAppearances)
-                return true;
-        }
-        return false;
-    }
-    /**
-     * Update the appearance streams for each of this dropdown's widgets using
-     * the default appearance provider for dropdowns. For example:
-     * ```js
-     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.defaultUpdateAppearances(helvetica)
-     * ```
-     * @param font The font to be used for creating the appearance streams.
-     */
-    defaultUpdateAppearances(font) {
-        (0, utils_1.assertIs)(font, 'font', [[PDFFont_1.default, 'PDFFont']]);
-        this.updateAppearances(font);
-    }
-    /**
-     * Update the appearance streams for each of this dropdown's widgets using
-     * the given appearance provider. If no `provider` is passed, the default
-     * appearance provider for dropdowns will be used. For example:
-     * ```js
-     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
-     * const dropdown = form.getDropdown('some.dropdown.field')
-     * dropdown.updateAppearances(helvetica, (field, widget, font) => {
-     *   ...
-     *   return drawTextField(...)
-     * })
-     * ```
-     * @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, provider) {
-        (0, utils_1.assertIs)(font, 'font', [[PDFFont_1.default, 'PDFFont']]);
-        (0, utils_1.assertOrUndefined)(provider, 'provider', [Function]);
-        const widgets = this.acroField.getWidgets();
-        for (let idx = 0, len = widgets.length; idx < len; idx++) {
-            const widget = widgets[idx];
-            this.updateWidgetAppearance(widget, font, provider);
-        }
-        this.markAsClean();
-    }
-    // getOption(index: number): string {}
-    // getSelectedIndices(): number[] {}
-    // removeOptions(option: string | string[]) {}
-    // removeIndices(option: number[]) {}
-    // deselect(options: string | string[]) {}
-    // deselectIndices(optionIndices: number[]) {}
-    updateWidgetAppearance(widget, font, provider) {
-        const apProvider = provider ?? appearances_1.defaultDropdownAppearanceProvider;
-        const appearances = (0, appearances_1.normalizeAppearance)(apProvider(this, widget, font));
-        this.updateWidgetAppearanceWithFont(widget, font, appearances);
-    }
-}
-/**
- * > **NOTE:** You probably don't want to call this method directly. Instead,
- * > consider using the [[PDFForm.getDropdown]] method, which will create an
- * > instance of [[PDFDropdown]] for you.
- *
- * Create an instance of [[PDFDropdown]] from an existing acroComboBox and ref
- *
- * @param acroComboBox The underlying `PDFAcroComboBox` for this dropdown.
- * @param ref The unique reference for this dropdown.
- * @param doc The document to which this dropdown will belong.
- */
-Object.defineProperty(PDFDropdown, "of", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: (acroComboBox, ref, doc) => new PDFDropdown(acroComboBox, ref, doc)
-});
-exports.default = PDFDropdown;
-//# sourceMappingURL=PDFDropdown.js.map

package/dist/node/src/api/form/PDFDropdown.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PDFDropdown.js","sourceRoot":"","sources":["../../../../../src/api/form/PDFDropdown.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yDAAiC;AACjC,yDAAiC;AACjC,uDAA4F;AAC5F,+CAIuB;AACvB,sCAAgC;AAChC,4CAAuC;AAEvC,qCAQoB;AACpB,uCAA0E;AAE1E;;;;;;;;;;;GAWG;AACH,MAAqB,WAAY,SAAQ,kBAAQ;IAkB/C,YAAoB,YAA6B,EAAE,GAAW,EAAE,GAAgB;QAC9E,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAJhC,8DAA8D;QACrD;;;;;WAA2B;QAKlC,IAAA,gBAAQ,EAAC,YAAY,EAAE,cAAc,EAAE,CAAC,CAAC,sBAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAE/E,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;IAChC,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU;QACR,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAE/C,MAAM,OAAO,GAAG,IAAI,KAAK,CAAS,UAAU,CAAC,MAAM,CAAC,CAAC;QACrD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QACjD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW;QACT,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QAE1C,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAS,MAAM,CAAC,MAAM,CAAC,CAAC;QAClD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACxD,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3C,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAiB;QAC1B,IAAA,gBAAQ,EAAC,OAAO,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtC,MAAM,aAAa,GAAG,IAAI,KAAK,CAA0B,OAAO,CAAC,MAAM,CAAC,CAAC;QACzE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,mBAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACtE,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,OAA0B;QACnC,IAAA,gBAAQ,EAAC,OAAO,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAEhD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAEhE,MAAM,eAAe,GAGf,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAElC,MAAM,UAAU,GAAG,IAAI,KAAK,CAA0B,UAAU,CAAC,MAAM,CAAC,CAAC;QACzE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YAC5D,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,mBAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACtE,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,OAA0B,EAAE,KAAK,GAAG,KAAK;QAC9C,IAAA,gBAAQ,EAAC,OAAO,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAChD,IAAA,gBAAQ,EAAC,KAAK,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAEtC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAEhE,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QACpF,IAAI,eAAe;YAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QAE1C,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAChE,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,KAAK,CAAe,UAAU,CAAC,MAAM,CAAC,CAAC;QAC1D,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YAC5D,MAAM,CAAC,GAAG,CAAC,GAAG,mBAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YAClD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,QAAgB;QAC1B,IAAA,sBAAc,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa;QACX,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa;QACX,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc;QACZ,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,iBAAiB;QACf,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,kBAAkB;QAChB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc;QACZ,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,eAAe,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB;QACjB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,oBAAoB;QAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,iBAAiB,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACH,mBAAmB;QACjB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB;QAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,CAAC,IAAa,EAAE,OAAgC;QACvD,IAAA,gBAAQ,EAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,uCAA4B,EAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,EAAE,CAAC;QAE3B,IAAI,CAAC,CAAC,WAAW,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,SAAS,GAAG,IAAA,YAAG,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,IAAI,CAAC,CAAC,iBAAiB,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,eAAe,GAAG,IAAA,YAAG,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,WAAW,GAAG,IAAA,YAAG,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC;QAEzD,oCAAoC;QACpC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;YAC/B,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;YACjB,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;YACjB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG;YAC3B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;YAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAA,mBAAO,EAAC,CAAC,CAAC;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,IAAI,CAAC,GAAG;SACf,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzD,2BAA2B;QAC3B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAEpC,oCAAoC;QACpC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,cAAc,EAAE,CAAC;QACjE,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE1C,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,sBAAsB;QACpB,IAAI,IAAI,CAAC,OAAO,EAAE;YAAE,OAAO,IAAI,CAAC;QAEhC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,EAAE,EAAE,MAAM,YAAY,gBAAS,CAAC;YAC5E,IAAI,CAAC,cAAc;gBAAE,OAAO,IAAI,CAAC;QACnC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACH,wBAAwB,CAAC,IAAa;QACpC,IAAA,gBAAQ,EAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,IAAa,EAAE,QAA6C;QAC5E,IAAA,gBAAQ,EAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,yBAAiB,EAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEpD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,sCAAsC;IACtC,oCAAoC;IACpC,8CAA8C;IAC9C,qCAAqC;IACrC,0CAA0C;IAC1C,8CAA8C;IAEtC,sBAAsB,CAC5B,MAA2B,EAC3B,IAAa,EACb,QAA6C;QAE7C,MAAM,UAAU,GAAG,QAAQ,IAAI,+CAAiC,CAAC;QACjE,MAAM,WAAW,GAAG,IAAA,iCAAmB,EAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;;AAvlBD;;;;;;;;;;GAUG;AACI;;;;WAAK,CAAC,YAA6B,EAAE,GAAW,EAAE,GAAgB,EAAE,EAAE,CAC3E,IAAI,WAAW,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC;EADhC,CACiC;kBAbvB,WAAW"}