@syncfusion/ej2-pdf 24.1.47 → 24.1.48

package/dist/global/index.d.ts

@@ -1,12 +1,3 @@
-/*!
-*  filename: index.d.ts
-*  version : 24.1.47
-*  Copyright Syncfusion Inc. 2001 - 2023. All rights reserved.
-*  Use of this code is subject to the terms of our license.
-*  A copy of the current license can be obtained at any time by e-mailing
-*  licensing@syncfusion.com. Any infringement will be prosecuted under
-*  applicable laws. 
-*/
 import * as _pdf from '@syncfusion/ej2-pdf';
 
 export declare namespace ej {

package/package.json

@@ -1,61 +1,61 @@
 {
-  "_from": "@syncfusion/ej2-pdf@*",
-  "_id": "@syncfusion/ej2-pdf@24.1.44",
-  "_inBundle": false,
-  "_integrity": "sha512-aOz4V/vjx4W8nYjz7OdAG+U/8Av/j2vPWwrePYH3TijbDR5UNjmm4gJadtnGJTTk49UOFCgx+S7uiwfVBNwXiA==",
-  "_location": "/@syncfusion/ej2-pdf",
-  "_phantomChildren": {},
-  "_requested": {
-    "type": "range",
-    "registry": true,
-    "raw": "@syncfusion/ej2-pdf@*",
-    "name": "@syncfusion/ej2-pdf",
-    "escapedName": "@syncfusion%2fej2-pdf",
-    "scope": "@syncfusion",
-    "rawSpec": "*",
-    "saveSpec": null,
-    "fetchSpec": "*"
-  },
-  "_requiredBy": [
-    "/",
-    "/@syncfusion/ej2",
-    "/@syncfusion/ej2-pdfviewer"
-  ],
-  "_resolved": "https://nexus.syncfusion.com/repository/ej2-hotfix-new/@syncfusion/ej2-pdf/-/ej2-pdf-24.1.44.tgz",
-  "_shasum": "ff127c776ad25203a3426bb532309f0f3ec03200",
-  "_spec": "@syncfusion/ej2-pdf@*",
-  "_where": "/jenkins/workspace/elease-automation_release_24.1.1/packages/included",
-  "author": {
-    "name": "Syncfusion Inc."
-  },
-  "bundleDependencies": false,
-  "dependencies": {
-    "@syncfusion/ej2-base": "~24.1.46",
-    "@syncfusion/ej2-compression": "~24.1.41"
-  },
-  "deprecated": false,
-  "description": "Feature-rich JavaScript PDF library with built-in support for loading and manipulating PDF document.",
-  "devDependencies": {},
-  "es2015": "./dist/es6/ej2-pdf.es5.js",
-  "keywords": [
-    "ej2",
-    "syncfusion",
-    "ej2-pdf",
-    "web-components",
-    "JavaScript",
-    "TypeScript",
-    "pdf"
-  ],
-  "license": "SEE LICENSE IN license",
-  "main": "./dist/ej2-pdf.umd.min.js",
-  "module": "./index.js",
-  "name": "@syncfusion/ej2-pdf",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/syncfusion/ej2-javascript-ui-controls/tree/master/controls/pdf"
-  },
-  "typings": "index.d.ts",
-  "version": "24.1.47",
-  "sideEffects": false,
-  "homepage": "https://www.syncfusion.com/javascript-ui-controls"
-}
+	"_from": "@syncfusion/ej2-pdf@*",
+	"_id": "@syncfusion/ej2-pdf@24.1.44",
+	"_inBundle": false,
+	"_integrity": "sha512-aOz4V/vjx4W8nYjz7OdAG+U/8Av/j2vPWwrePYH3TijbDR5UNjmm4gJadtnGJTTk49UOFCgx+S7uiwfVBNwXiA==",
+	"_location": "/@syncfusion/ej2-pdf",
+	"_phantomChildren": {},
+	"_requested": {
+	  "type": "range",
+	  "registry": true,
+	  "raw": "@syncfusion/ej2-pdf@*",
+	  "name": "@syncfusion/ej2-pdf",
+	  "escapedName": "@syncfusion%2fej2-pdf",
+	  "scope": "@syncfusion",
+	  "rawSpec": "*",
+	  "saveSpec": null,
+	  "fetchSpec": "*"
+	},
+	"_requiredBy": [
+	  "/",
+	  "/@syncfusion/ej2",
+	  "/@syncfusion/ej2-pdfviewer"
+	],
+	"_resolved": "https://nexus.syncfusion.com/repository/ej2-hotfix-new/@syncfusion/ej2-pdf/-/ej2-pdf-24.1.44.tgz",
+	"_shasum": "ff127c776ad25203a3426bb532309f0f3ec03200",
+	"_spec": "@syncfusion/ej2-pdf@*",
+	"_where": "/jenkins/workspace/elease-automation_release_24.1.1/packages/included",
+	"author": {
+	  "name": "Syncfusion Inc."
+	},
+	"bundleDependencies": false,
+	"dependencies": {
+	  "@syncfusion/ej2-base": "~24.1.46",
+	  "@syncfusion/ej2-compression": "~24.1.41"
+	},
+	"deprecated": false,
+	"description": "Feature-rich JavaScript PDF library with built-in support for loading and manipulating PDF document.",
+	"devDependencies": {},
+	"es2015": "./dist/es6/ej2-pdf.es5.js",
+	"keywords": [
+	  "ej2",
+	  "syncfusion",
+	  "ej2-pdf",
+	  "web-components",
+	  "JavaScript",
+	  "TypeScript",
+	  "pdf"
+	],
+	"license": "SEE LICENSE IN license",
+	"main": "./dist/ej2-pdf.umd.min.js",
+	"module": "./index.js",
+	"name": "@syncfusion/ej2-pdf",
+	"repository": {
+	  "type": "git",
+	  "url": "https://github.com/syncfusion/ej2-javascript-ui-controls/tree/master/controls/pdf"
+	},
+	"typings": "index.d.ts",
+	"version": "24.1.48",
+	"sideEffects": false,
+	"homepage": "https://www.syncfusion.com/javascript-ui-controls"
+  }

package/src/pdf/core/annotations/annotation.d.ts

@@ -3453,7 +3453,7 @@ export declare class PdfSoundAnnotation extends PdfComment {
  * // Get the first page
  * let page: PdfPage = document.getPage(0) as PdfPage;
  * // Create a new free text annotation
- * const annotation: PdfFreeTextAnnotation = new PdfFreeTextAnnotation (50, 100, 100, 50);
+ * const annotation: PdfFreeTextAnnotation = new PdfFreeTextAnnotation(50, 100, 100, 50);
  * // Add annotation to the page
  * page.annotations.add(annotation);
  * // Destroy the document
@@ -3495,7 +3495,7 @@ export declare class PdfFreeTextAnnotation extends PdfComment {
      * // Get the first page
      * let page: PdfPage = document.getPage(0) as PdfPage;
      * // Create a new free text annotation
-     * const annotation: PdfFreeTextAnnotation = new PdfFreeTextAnnotation (50, 100, 100, 50);
+     * const annotation: PdfFreeTextAnnotation = new PdfFreeTextAnnotation(50, 100, 100, 50);
      * // Add annotation to the page
      * page.annotations.add(annotation);
      * // Destroy the document
@@ -4132,6 +4132,7 @@ export declare class PdfWidgetAnnotation extends PdfAnnotation {
     _visibility: PdfFormFieldVisibility;
     _fontName: string;
     _isFont: boolean;
+    _isTransparentBackColor: boolean;
     /**
      * Initializes a new instance of the `PdfWidgetAnnotation` class.
      *
@@ -4212,12 +4213,10 @@ export declare class PdfWidgetAnnotation extends PdfAnnotation {
      * ```typescript
      * // Load an existing PDF document
      * let document: PdfDocument = new PdfDocument(data, password);
-     * // Get the first page
-     * let page: PdfPage = document.getPage(0) as PdfPage;
-     * // Get the first annotation of the page
-     * let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
+     * // Access the text box field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
      * // Gets the back color of the annotation
-     * let backColor: number[] = annotation.backColor;
+     * let backColor: number[] = field.itemAt(0).backColor;
      * // Destroy the document
      * document.destroy();
      * ```
@@ -4225,16 +4224,16 @@ export declare class PdfWidgetAnnotation extends PdfAnnotation {
     /**
     * Sets the back color of the annotation.
     *
-    * @param {number[]} value Color as R, G, B color array in between 0 to 255.
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
     * ```typescript
     * // Load an existing PDF document
     * let document: PdfDocument = new PdfDocument(data, password);
-    * // Get the first page
-    * let page: PdfPage = document.getPage(0) as PdfPage;
-    * // Get the first annotation of the page
-    * let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
-    * // Sets the back color of the annotation.
-    * annotation.backColor = [255,255,255];
+    * // Access the text box field at index 0
+    * let field: PdfField = document.form.fieldAt(0);
+    * // Sets the background color of the field item
+    * field.itemAt(0).backColor = [255, 0, 0];
+    * // Sets the background color of the field item to transparent
+    * field.itemAt(1).backColor = [0, 0, 0, 0];
     * // Save the document
     * document.save('output.pdf');
     * // Destroy the document
@@ -4242,6 +4241,7 @@ export declare class PdfWidgetAnnotation extends PdfAnnotation {
     * ```
     */
     backColor: number[];
+    readonly _hasBackColor: boolean;
     /**
      * Gets the border color of the annotation.
      *
@@ -4522,6 +4522,8 @@ export declare class PdfWidgetAnnotation extends PdfAnnotation {
     _initializeFont(font: PdfFont): void;
     _getPage(): PdfPage;
     _beginSave(): void;
+    _parseBackColor(): number[];
+    _updateBackColor(value: number[], setAppearance?: boolean): void;
 }
 /**
  * `PdfStateItem` class represents the check box field item objects.
@@ -4836,6 +4838,47 @@ export declare class PdfRadioButtonListItem extends PdfStateItem {
     * ```
     */
     value: string;
+    /**
+     * Gets the back color of the annotation.
+     *
+     * @returns {number[]} Color as R, G, B color array in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Get the first page
+     * let page: PdfPage = document.getPage(0) as PdfPage;
+     * // Get the first annotation of the page
+     * let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
+     * // Gets the back color of the annotation
+     * let backColor: number[] = annotation.backColor;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the back color of the annotation.
+    *
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data);
+    * // Gets the first page of the document
+    * let page: PdfPage = document.getPage(0);
+    * // Access the PDF form
+    * let form: PdfForm = document.form;
+    * // Access the radio button list field
+    * let field: PdfRadioButtonListField = form.fieldAt(0) as PdfRadioButtonListField;
+    * // Sets the back color of the radio button list item
+    * field.itemAt(0).backColor = [255, 255, 255];
+    * // Sets the background color of the field item to transparent
+    * field.itemAt(1).backColor = [0, 0, 0, 0];
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    backColor: number[];
     _initializeItem(value: string, bounds: {
         x: number;
         y: number;

package/src/pdf/core/annotations/annotation.js

@@ -10060,7 +10060,7 @@ export { PdfSoundAnnotation };
  * // Get the first page
  * let page: PdfPage = document.getPage(0) as PdfPage;
  * // Create a new free text annotation
- * const annotation: PdfFreeTextAnnotation = new PdfFreeTextAnnotation (50, 100, 100, 50);
+ * const annotation: PdfFreeTextAnnotation = new PdfFreeTextAnnotation(50, 100, 100, 50);
  * // Add annotation to the page
  * page.annotations.add(annotation);
  * // Destroy the document
@@ -11878,6 +11878,7 @@ var PdfWidgetAnnotation = /** @class */ (function (_super) {
         _this._isAutoResize = false;
         _this._visibility = PdfFormFieldVisibility.visible;
         _this._isFont = false;
+        _this._isTransparentBackColor = false;
         _this._isWidget = true;
         _this._type = _PdfAnnotationType.widgetAnnotation;
         return _this;
@@ -11992,44 +11993,30 @@ var PdfWidgetAnnotation = /** @class */ (function (_super) {
          * ```typescript
          * // Load an existing PDF document
          * let document: PdfDocument = new PdfDocument(data, password);
-         * // Get the first page
-         * let page: PdfPage = document.getPage(0) as PdfPage;
-         * // Get the first annotation of the page
-         * let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
+         * // Access the text box field at index 0
+         * let field: PdfField = document.form.fieldAt(0);
          * // Gets the back color of the annotation
-         * let backColor: number[] = annotation.backColor;
+         * let backColor: number[] = field.itemAt(0).backColor;
          * // Destroy the document
          * document.destroy();
          * ```
          */
         get: function () {
-            if (typeof this._backColor === 'undefined') {
-                var dictionary = this._mkDictionary;
-                if (dictionary && dictionary.has('BG')) {
-                    var colorArray = dictionary.getArray('BG');
-                    if (colorArray) {
-                        this._backColor = _parseColor(colorArray);
-                    }
-                }
-            }
-            if (typeof this._backColor === 'undefined' || this._backColor === null) {
-                this._backColor = [255, 255, 255];
-            }
-            return this._backColor;
+            return this._parseBackColor();
         },
         /**
          * Sets the back color of the annotation.
          *
-         * @param {number[]} value Color as R, G, B color array in between 0 to 255.
+         * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
          * ```typescript
          * // Load an existing PDF document
          * let document: PdfDocument = new PdfDocument(data, password);
-         * // Get the first page
-         * let page: PdfPage = document.getPage(0) as PdfPage;
-         * // Get the first annotation of the page
-         * let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
-         * // Sets the back color of the annotation.
-         * annotation.backColor = [255,255,255];
+         * // Access the text box field at index 0
+         * let field: PdfField = document.form.fieldAt(0);
+         * // Sets the background color of the field item
+         * field.itemAt(0).backColor = [255, 0, 0];
+         * // Sets the background color of the field item to transparent
+         * field.itemAt(1).backColor = [0, 0, 0, 0];
          * // Save the document
          * document.save('output.pdf');
          * // Destroy the document
@@ -12037,14 +12024,19 @@ var PdfWidgetAnnotation = /** @class */ (function (_super) {
          * ```
          */
         set: function (value) {
-            if (typeof this.backColor === 'undefined' || this.backColor !== value) {
-                if (typeof this._mkDictionary === 'undefined') {
-                    this._dictionary.update('MK', new _PdfDictionary(this._crossReference));
-                }
-                this._mkDictionary.update('BG', [Number.parseFloat((value[0] / 255).toFixed(3)),
-                    Number.parseFloat((value[1] / 255).toFixed(3)),
-                    Number.parseFloat((value[2] / 255).toFixed(3))]);
-                this._backColor = value;
+            this._updateBackColor(value);
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(PdfWidgetAnnotation.prototype, "_hasBackColor", {
+        get: function () {
+            if (this._isLoaded) {
+                var mkDictionary = this._mkDictionary;
+                return (mkDictionary && mkDictionary.has('BG'));
+            }
+            else {
+                return !this._isTransparentBackColor;
             }
         },
         enumerable: true,
@@ -12721,6 +12713,59 @@ var PdfWidgetAnnotation = /** @class */ (function (_super) {
             this._dictionary.update('Rect', _getUpdatedBounds([value.x, value.y, value.width, value.height], this._page));
         }
     };
+    PdfWidgetAnnotation.prototype._parseBackColor = function () {
+        var value;
+        if ((this._isLoaded && this._hasBackColor) || (!this._isLoaded && !this._isTransparentBackColor)) {
+            if (typeof this._backColor === 'undefined') {
+                var dictionary = this._mkDictionary;
+                if (dictionary && dictionary.has('BG')) {
+                    var colorArray = dictionary.getArray('BG');
+                    if (colorArray) {
+                        this._backColor = _parseColor(colorArray);
+                    }
+                }
+            }
+            if (typeof this._backColor === 'undefined' || this._backColor === null) {
+                this._backColor = [255, 255, 255];
+            }
+            value = this._backColor;
+        }
+        return value;
+    };
+    PdfWidgetAnnotation.prototype._updateBackColor = function (value, setAppearance) {
+        if (setAppearance === void 0) { setAppearance = false; }
+        var isChanged = false;
+        if (value.length === 4 && value[3] !== 255) {
+            this._isTransparentBackColor = true;
+            if (this._dictionary.has('BG')) {
+                delete this._dictionary._map.BG;
+                isChanged = true;
+            }
+            var mkDictionary = this._mkDictionary;
+            if (mkDictionary && mkDictionary.has('BG')) {
+                delete mkDictionary._map.BG;
+                this._dictionary._updated = true;
+                isChanged = true;
+            }
+        }
+        else {
+            this._isTransparentBackColor = false;
+            if (typeof this.backColor === 'undefined' || this._backColor !== value) {
+                if (typeof this._mkDictionary === 'undefined') {
+                    this._dictionary.update('MK', new _PdfDictionary(this._crossReference));
+                }
+                this._mkDictionary.update('BG', [Number.parseFloat((value[0] / 255).toFixed(3)),
+                    Number.parseFloat((value[1] / 255).toFixed(3)),
+                    Number.parseFloat((value[2] / 255).toFixed(3))]);
+                this._backColor = [value[0], value[1], value[2]];
+                this._dictionary._updated = true;
+                isChanged = true;
+            }
+        }
+        if (setAppearance && isChanged && this._field) {
+            this._field._setAppearance = true;
+        }
+    };
     return PdfWidgetAnnotation;
 }(PdfAnnotation));
 export { PdfWidgetAnnotation };
@@ -13074,6 +13119,56 @@ var PdfRadioButtonListItem = /** @class */ (function (_super) {
         enumerable: true,
         configurable: true
     });
+    Object.defineProperty(PdfRadioButtonListItem.prototype, "backColor", {
+        /**
+         * Gets the back color of the annotation.
+         *
+         * @returns {number[]} Color as R, G, B color array in between 0 to 255.
+         * ```typescript
+         * // Load an existing PDF document
+         * let document: PdfDocument = new PdfDocument(data, password);
+         * // Get the first page
+         * let page: PdfPage = document.getPage(0) as PdfPage;
+         * // Get the first annotation of the page
+         * let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
+         * // Gets the back color of the annotation
+         * let backColor: number[] = annotation.backColor;
+         * // Destroy the document
+         * document.destroy();
+         * ```
+         */
+        get: function () {
+            return this._parseBackColor();
+        },
+        /**
+         * Sets the back color of the annotation.
+         *
+         * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+         * ```typescript
+         * // Load an existing PDF document
+         * let document: PdfDocument = new PdfDocument(data);
+         * // Gets the first page of the document
+         * let page: PdfPage = document.getPage(0);
+         * // Access the PDF form
+         * let form: PdfForm = document.form;
+         * // Access the radio button list field
+         * let field: PdfRadioButtonListField = form.fieldAt(0) as PdfRadioButtonListField;
+         * // Sets the back color of the radio button list item
+         * field.itemAt(0).backColor = [255, 255, 255];
+         * // Sets the background color of the field item to transparent
+         * field.itemAt(1).backColor = [0, 0, 0, 0];
+         * // Save the document
+         * document.save('output.pdf');
+         * // Destroy the document
+         * document.destroy();
+         * ```
+         */
+        set: function (value) {
+            this._updateBackColor(value, true);
+        },
+        enumerable: true,
+        configurable: true
+    });
     PdfRadioButtonListItem.prototype._initializeItem = function (value, bounds, page, field) {
         this._optionValue = value;
         this._page = page;