@syncfusion/ej2-pdf 1.0.23 → 23.1.36

package/src/pdf/core/pdf-document.d.ts

@@ -0,0 +1,821 @@
+import { _PdfStream } from './base-stream';
+import { _PdfCrossReference } from './pdf-cross-reference';
+import { _Linearization } from './pdf-parser';
+import { _PdfCatalog } from './pdf-catalog';
+import { _PdfDictionary, _PdfReference } from './pdf-primitives';
+import { PdfPage } from './pdf-page';
+import { DataFormat, PdfPermissionFlag } from './enumerator';
+import { PdfForm } from './form/form';
+import { PdfBookmarkBase, _PdfNamedDestinationCollection } from './pdf-outline';
+import { PdfFileStructure } from './pdf-file-structure';
+/**
+ * Represents a PDF document and can be used to parse an existing PDF document.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data);
+ * // Access first page
+ * let page: PdfPage = document.getPage(0);
+ * // Flatten annotations and form fields
+ * document.flatten = true;
+ * // Save the document
+ * document.save('output.pdf');
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfDocument {
+    _stream: _PdfStream;
+    _crossReference: _PdfCrossReference;
+    _catalog: _PdfCatalog;
+    _fileStructure: PdfFileStructure;
+    private _headerSignature;
+    private _startXrefSignature;
+    private _endObjSignature;
+    private _version;
+    private _pages;
+    private _linear;
+    private _pageCount;
+    private _flatten;
+    _permissions: PdfPermissionFlag;
+    _form: PdfForm;
+    _bookmarkBase: PdfBookmarkBase;
+    _namedDestinationCollection: _PdfNamedDestinationCollection;
+    _isEncrypted: boolean;
+    _isUserPassword: boolean;
+    _hasUserPasswordOnly: boolean;
+    _encryptOnlyAttachment: boolean;
+    _encryptMetaData: boolean;
+    private _allowCustomData;
+    /**
+     * Initializes a new instance of the `PdfDocument` class.
+     *
+     * @param {string} data PDF data as Base64 string.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Access first page
+     * let page: PdfPage = document.getPage(0);
+     * // Flatten annotations and form fields
+     * document.flatten = true;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    constructor(data: string);
+    /**
+     * Initializes a new instance of the `PdfDocument` class with password.
+     *
+     * @param {string} data PDF data as Base64 string.
+     * @param {string} password Password to decrypt PDF.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access first page
+     * let page: PdfPage = document.getPage(0);
+     * // Flatten annotations and form fields
+     * document.flatten = true;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    constructor(data: string, password: string);
+    /**
+     * Initializes a new instance of the `PdfDocument` class.
+     *
+     * @param {Uint8Array} data PDF data as byte array.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Access first page
+     * let page: PdfPage = document.getPage(0);
+     * // Flatten annotations and form fields
+     * document.flatten = true;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    constructor(data: Uint8Array);
+    /**
+     * Initializes a new instance of the `PdfDocument` class with password.
+     *
+     * @param {Uint8Array} data PDF data as byte array.
+     * @param {string} password Password to decrypt PDF.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access first page
+     * let page: PdfPage = document.getPage(0);
+     * // Flatten annotations and form fields
+     * document.flatten = true;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    constructor(data: Uint8Array, password: string);
+    _allowImportCustomData: boolean;
+    readonly _linearization: _Linearization;
+    readonly _startXRef: number;
+    /**
+     * Gets a value indicating whether the document is encrypted. (Read Only).
+     *
+     * @returns {boolean} A boolean value indicates whether the document is encrypted.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Gets a value indicating whether the document is encrypted.
+     * let isEncrypted: boolean = document.isEncrypted;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly isEncrypted: boolean;
+    /**
+     * Gets a value indicating whether the document is decrypted using the user password. (Read only).
+     *
+     * @returns {boolean} A boolean value indicates whether the document is decrypted using the user password.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Gets a value indicating whether the document is decrypted using the user password
+     * let isUserPassword: boolean = document.isUserPassword;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly isUserPassword: boolean;
+    /**
+     * Gets the page count (Read only).
+     *
+     * @returns {number} Number of pages
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Gets the page count
+     * let count: number = document.pageCount;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly pageCount: number;
+    /**
+     * Gets the PDF form fields included in the document (Read only).
+     *
+     * @returns {PdfForm} Form object
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access loaded form
+     * let form: PdfForm = document.form;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly form: PdfForm;
+    /**
+     * Gets the boolean flag to flatten the annotations and form fields.
+     *
+     * @returns {boolean} Flag to flatten
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Gets the flatten value applied
+     * let flatten: boolean = document.flatten;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the boolean flag to flatten the annotations and form fields.
+    *
+    * @param {boolean} value to flatten
+    *
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Flatten PDF annotations and form fields
+    * document.flatten = true;
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    flatten: boolean;
+    /**
+     * Gets the permission flag of the PDF document (Read only).
+     *
+     * @returns {PdfPermissionFlag} permission flag. Default value is PdfPermissionFlag.default.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Gets the permission flag
+     * let permission: PdfPermissionFlag = document.permissions;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly permissions: PdfPermissionFlag;
+    /**
+     * Gets the bookmarks (Read only).
+     *
+     * @returns {PdfBookmarkBase} Bookmarks.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get bookmarks
+     * let bookmarks: PdfBookmarkBase = document.bookmarks;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly bookmarks: PdfBookmarkBase;
+    /**
+     * Gets the internal structure of the PDF document.
+     *
+     * @returns {PdfFileStructure} The internal structure of the PDF document.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the internal file structure of the PDF document
+     * let fileStructure: PdfFileStructure = document.fileStructure;
+     * // Get the cross reference type
+     * let type: PdfCrossReferenceType = fileStructure.crossReferenceType;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly fileStructure: PdfFileStructure;
+    /**
+     * Gets the `PdfPage` at the specified index.
+     *
+     * @param {number} pageIndex Page index.
+     * @returns {PdfPage} PDF page at the specified index.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access first page
+     * let page: PdfPage = document.getPage(0);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    getPage(pageIndex: number): PdfPage;
+    /**
+     * Saves the modified document.
+     *
+     * @returns {Uint8Array} Saved PDF data as byte array.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Save the document
+     * let data: Uint8Array = document.save();
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    save(): Uint8Array;
+    /**
+     * Saves the modified document to the specified filename.
+     *
+     * @param {string} filename Specifies the filename to save the output pdf document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Save the document
+     * document.save('Output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    save(filename: string): void;
+    /**
+     * Saves the document to the specified output stream and return the stream as Blob.
+     *
+     * @returns {Promise<{ blobData: Blob }>} Saved PDF data as `Blob`.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Save the document
+     * let data: Promise<{ blobData: Blob }> = document.saveAsBlob();
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    saveAsBlob(): Promise<{
+        blobData: Blob;
+    }>;
+    /**
+     * Exports the annotations from the PDF document.
+     *
+     * @returns {Uint8Array} Exported annotation data as byte array.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Exports the annotations from the PDF document.
+     * let data: Uint8Array = document.exportAnnotations();
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportAnnotations(): Uint8Array;
+    /**
+     * Exports the annotations from the PDF document.
+     *
+     * @param {PdfAnnotationExportSettings} settings Annotation export settings.
+     * @returns {Uint8Array} Exported annotation data as byte array.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Sets export data format as JSON type to annotation export settings
+     * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+     * settings.dataFormat = DataFormat.json;
+     * // Export annotations to JSON format
+     * let json: Uint8Array = document.exportAnnotations(settings);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportAnnotations(settings: PdfAnnotationExportSettings): Uint8Array;
+    /**
+     * Exports the annotations from the PDF document.
+     *
+     * @param {string} filename Output file name.
+     * @returns {void} Exports the annotations from the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Exports the annotations from the PDF document.
+     * document.exportAnnotations('annotations.xfdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportAnnotations(filename: string): void;
+    /**
+     * Exports the annotations from the PDF document.
+     *
+     * @param {string} filename Output file name.
+     * @param {PdfAnnotationExportSettings} settings Annotation export settings.
+     * @returns {void} Exports the annotations from the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Sets export data format as JSON type to annotation export settings
+     * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+     * settings.dataFormat = DataFormat.json;
+     * // Export annotations to JSON format
+     * let json: Uint8Array = document.exportAnnotations('annotations.json', settings);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportAnnotations(filename: string, settings: PdfAnnotationExportSettings): void;
+    /**
+     * Exports the form data from the PDF document.
+     *
+     * @returns {Uint8Array} Exported form data as byte array.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Exports the form data from the PDF document.
+     * let data: Uint8Array = document.exportFormData();
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportFormData(): Uint8Array;
+    /**
+     * Exports the form data from the PDF document.
+     *
+     * @param {PdfFormFieldExportSettings} settings Form field export settings.
+     * @returns {Uint8Array} Exported form data as byte array.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Sets the form field data export settings with output data format.
+     * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+     * settings.dataFormat = DataFormat.json;
+     * // Export form field to JSON format
+     * let json: Uint8Array = document.exportFormData(settings);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportFormData(settings: PdfFormFieldExportSettings): Uint8Array;
+    /**
+     * Exports the form data from the PDF document.
+     *
+     * @param {string} filename Output file name.
+     * @returns {void} Exports the form data from the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Export form field to XFDF format
+     * let xfdf: Uint8Array = document.exportFormData(‘formData.xfdf’);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportFormData(filename: string): void;
+    /**
+     * Exports the form data from the PDF document.
+     *
+     * @param {string} filename Output file name.
+     * @param {PdfFormFieldExportSettings} settings Form field export settings.
+     * @returns {void} Exports the form data from the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Sets the form field data export settings with output data format.
+     * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+     * settings.dataFormat = DataFormat.json;
+     * // Export form field to JSON format
+     * let json: Uint8Array = document.exportFormData('formData.json', settings);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    exportFormData(filename: string, settings: PdfFormFieldExportSettings): void;
+    /**
+     * Imports the annotations from the PDF document.
+     *
+     * @param {string} data annotations data as base64 string.
+     * @param {DataFormat} dataFormat Data format of the input data.
+     * @returns {void} Imports the annotations to the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Imports annotations from to the PDF document.
+     * document.importAnnotations('annotations.json', DataFormat.json);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    importAnnotations(data: string, dataFormat: DataFormat): void;
+    /**
+     * Imports the annotations from the PDF document.
+     *
+     * @param {Uint8Array} data annotations data as byte array.
+     * @param {DataFormat} dataFormat Data format of the input data.
+     * @returns {void} Imports the annotations to the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Imports annotations from to the PDF document.
+     * document.importAnnotations(annotations, DataFormat.json);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    importAnnotations(data: Uint8Array, dataFormat: DataFormat): void;
+    /**
+     * Imports the form data from the PDF document.
+     *
+     * @param {string} data Form data as base64 string.
+     * @param {DataFormat} dataFormat Data format of the input data.
+     * @returns {void} Imports the form data to the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Imports form data from to the PDF document.
+     * document.importFormData('formData.json', DataFormat.json);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    importFormData(data: string, dataFormat: DataFormat): void;
+    /**
+     * Imports the form data from the PDF document.
+     *
+     * @param {Uint8Array} data Form data as byte array.
+     * @param {DataFormat} dataFormat Data format of the input data.
+     * @returns {void} Imports the form data to the PDF document.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Imports form data from to the PDF document.
+     * document.importFormData(data, DataFormat.json);
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    importFormData(data: Uint8Array, dataFormat: DataFormat): void;
+    /**
+     * Disposes the current instance of `PdfDocument` class.
+     *
+     * @returns {void} Nothing.
+     *
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    destroy(): void;
+    readonly _destinationCollection: _PdfNamedDestinationCollection;
+    _getLinearizationPage(pageIndex: number): {
+        dictionary: _PdfDictionary;
+        reference: _PdfReference;
+    };
+    _checkHeader(): void;
+    _parse(recoveryMode: boolean): void;
+    _find(stream: _PdfStream, signature: Uint8Array, limit?: number, backwards?: boolean): boolean;
+    _doPostProcess(isFlatten?: boolean): void;
+    _doPostProcessOnFormFields(isFlatten?: boolean): void;
+    _doPostProcessOnAnnotations(isFlatten?: boolean): void;
+    _addWatermarkText(): void;
+}
+/**
+ * Represents annotation export settings.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data, password);
+ * // Sets export data format as JSON type to annotation export settings
+ * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+ * // Set the data format defined in annotation export settings
+ * settings.dataFormat = DataFormat.json;
+ * // Export annotations to JSON format
+ * let json: Uint8Array = document.exportAnnotations(settings);
+ * // Save the document
+ * document.save('output.pdf');
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfAnnotationExportSettings {
+    _format: DataFormat;
+    _exportAppearance: boolean;
+    /**
+     * Gets the data format defined in annotation export settings.
+     *
+     * @returns {DataFormat} - Returns the data format.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Sets export data format as JSON type to annotation export settings
+     * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+     * // Export annotations to JSON format
+     * let json: Uint8Array = document.exportAnnotations(settings);
+     * // Get the data format defined in annotation export settings
+     * let dataFormat: DataFormat = settings.dataFormat;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the data format defined in annotation export settings.
+    *
+    * @param {DataFormat} format - Specifies the data format.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Sets export data format as JSON type to annotation export settings
+    * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+    * // Set the data format defined in annotation export settings
+    * settings.dataFormat = DataFormat.json;
+    * // Export annotations to JSON format
+    * let json: Uint8Array = document.exportAnnotations(settings);
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    dataFormat: DataFormat;
+    /**
+     * Gets the boolean value indicating whether the appearance of a particular object can be exported or not.
+     *
+     * @returns {boolean} - Returns the boolean value.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Sets the annotation export settings with enabled export appearance.
+     * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+     * // Export annotations to XFDF format
+     * let xfdf: Uint8Array = document.exportAnnotations(settings);
+     * // Get the boolean value indicating whether the appearance of a particular object can be exported or not
+     * let appearance: boolean = settings.exportAppearance;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the boolean value indicating whether the appearance of a particular object can be exported or not.
+    *
+    * @param {boolean} value - The boolean value.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Sets the annotation export settings with enabled export appearance.
+    * let settings: PdfAnnotationExportSettings = new PdfAnnotationExportSettings();
+    * // Set the boolean value indicating whether the appearance of a particular object can be exported or not
+    * settings.exportAppearance = true;
+    * // Export annotations to XFDF format
+    * let xfdf: Uint8Array = document.exportAnnotations(settings);
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    exportAppearance: boolean;
+}
+/**
+ * Represents form fields export settings.
+ * ```typescript
+ * // Load an existing PDF document
+ * let document: PdfDocument = new PdfDocument(data);
+ * // Sets the form field data export settings with output data format.
+ * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+ * // Set the data format defined in form field export settings.
+ * settings.dataFormat = DataFormat.json;
+ * // Export form field to JSON format
+ * let json: Uint8Array = document.exportFormData(settings);
+ * // Save the document
+ * document.save('output.pdf');
+ * // Destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfFormFieldExportSettings {
+    _format: DataFormat;
+    _exportName: string;
+    _asPerSpecification: boolean;
+    /**
+     * Gets the data format defined in form field export settings.
+     *
+     * @returns {DataFormat} - Returns the data format.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Sets the form field data export settings with output data format.
+     * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+     * // Export form field to JSON format
+     * let json: Uint8Array = document.exportFormData(settings);
+     * // Get the data format defined in form field export settings
+     * let dataFormat: DataFormat = settings.dataFormat;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the data format defined in form field export settings.
+    *
+    * @param {DataFormat} format - Specifies the data format.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data);
+    * // Sets the form field data export settings with output data format.
+    * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+    * // Set the data format defined in form field export settings.
+    * settings.dataFormat = DataFormat.json;
+    * // Export form field to JSON format
+    * let json: Uint8Array = document.exportFormData(settings);
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    dataFormat: DataFormat;
+    /**
+     * Gets the export name defined in form field export settings.
+     *
+     * @returns {string} - Returns the string value.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Sets the form field data export settings with export name.
+     * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+     * // Export form field to JSON format
+     * let json: Uint8Array = document.exportFormData(settings);
+     * // Get the export name defined in form field export settings
+     * let name: boolean = settings.exportName;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the export name defined in form field export settings.
+    *
+    * @param {string} name - Specifies the export name of the form.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data);
+    * // Sets the form field data export settings with export name.
+    * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+    * // Set the export name defined in form field export settings.
+    * settings.exportName = ‘JobApplication’.
+    * // Export form field to JSON format
+    * let json: Uint8Array = document.exportFormData(settings);
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    exportName: string;
+    /**
+     * Gets the boolean value indicating whether the data in a form field can be exported based on a certain specification.
+     *
+     * @returns {boolean} - Returns the boolean value.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data);
+     * // Sets the boolean value indicating whether the data in a form field can be exported based on a certain specification.
+     * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+     * // Export form field to JSON format
+     * let json: Uint8Array = document.exportFormData(settings);
+     * // Get the boolean value indicating whether the data in a form field can be exported based on a certain specification.
+     * let asPerSpecification: boolean = settings.asPerSpecification;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the boolean value indicating whether the data in a form field can be exported based on a certain specification.
+    *
+    * @param {boolean} value - The boolean value.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data);
+    * // Sets the boolean value indicating whether the data in a form field can be exported based on a certain specification.
+    * let settings: PdfFormFieldExportSettings = new PdfFormFieldExportSettings();
+    * // Set the boolean value indicating whether the data in a form field can be exported based on a certain specification.
+    * settings.asPerSpecification = true;
+    * // Export form field to JSON format
+    * let json: Uint8Array = document.exportFormData(settings);
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    asPerSpecification: boolean;
+}