@univerjs/sheets-drawing 1.0.0-insiders.20260813-7c9aa50 → 1.0.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -39,4 +39,3 @@ Use this package with `@univerjs/sheets-drawing-ui` when users need drawing inte
 - [Documentation](https://docs.univer.ai)
 - [NPM package](https://npmjs.com/package/@univerjs/sheets-drawing)
 - [GitHub repository](https://github.com/dream-num/univer)
-

package/lib/cjs/facade.js

@@ -1,3 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 let _univerjs_core = require("@univerjs/core");
 let _univerjs_core_facade = require("@univerjs/core/facade");
 let _univerjs_drawing = require("@univerjs/drawing");
@@ -6,7 +7,7 @@ let _univerjs_sheets_drawing = require("@univerjs/sheets-drawing");
 let _univerjs_engine_render = require("@univerjs/engine-render");
 let _univerjs_sheets_facade = require("@univerjs/sheets/facade");
 
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/typeof.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -17,7 +18,7 @@ function _typeof(o) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/toPrimitive.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -30,14 +31,14 @@ function toPrimitive(t, r) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/defineProperty.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -48,7 +49,7 @@ function _defineProperty(e, r, t) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/decorateParam.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
@@ -56,7 +57,7 @@ function __decorateParam(paramIndex, decorator) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/decorate.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -660,14 +661,38 @@ let FOverGridImageBuilder = class FOverGridImageBuilder {
 		this._image.angle = angle;
 		return this;
 	}
+	/**
+	* Sets the workbook unit ID of the image to build.
+	* @param {string} unitId The target workbook unit ID.
+	* @returns {FOverGridImageBuilder} This builder, for chaining.
+	*/
 	setUnitId(unitId) {
 		this._image.unitId = unitId;
 		return this;
 	}
+	/**
+	* Sets the worksheet ID of the image to build.
+	* @param {string} subUnitId The target worksheet ID.
+	* @returns {FOverGridImageBuilder} This builder, for chaining.
+	*/
 	setSubUnitId(subUnitId) {
 		this._image.subUnitId = subUnitId;
 		return this;
 	}
+	/**
+	* Builds image data for insertion or updating; this does not insert the image.
+	* An explicit placement takes precedence over the individual position and size fields.
+	* Without explicit placement, zero width or height is filled from the source image's intrinsic size.
+	* @returns {Promise<ISheetImage>} A promise resolving to the built sheet image data.
+	* @example
+	* ```ts
+	* const sheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
+	* if (sheet) {
+	*   const image = await sheet.newOverGridImage().setSource('https://example.com/image.png').buildAsync();
+	*   sheet.insertImages([image]);
+	* }
+	* ```
+	*/
 	async buildAsync() {
 		var _this$_placement;
 		const sheetSkeletonService = this._sheetSkeletonService;
@@ -694,7 +719,7 @@ let FOverGridImageBuilder = class FOverGridImageBuilder {
 					rowOffset: top + height
 				}
 			};
-			return (0, _univerjs_sheets_drawing.applySheetDrawingPlacement)({
+			const image = {
 				...this._image,
 				transform: {
 					left,
@@ -709,7 +734,8 @@ let FOverGridImageBuilder = class FOverGridImageBuilder {
 				},
 				sheetTransform,
 				axisAlignSheetTransform: sheetTransform
-			}, this._placement);
+			};
+			return (0, _univerjs_sheets_drawing.applySheetDrawingPlacement)(image, this._placement);
 		}
 		const image = convertFOverGridImageToSheetImage(this._image, sheetSkeletonService);
 		if (!this._placement) return image;
@@ -744,6 +770,14 @@ let FOverGridImage = class FOverGridImage extends _univerjs_core_facade.FBase {
 	getId() {
 		return this._image.drawingId;
 	}
+	/** Returns the workbook unit id that owns this image. */
+	getUnitId() {
+		return this._image.unitId;
+	}
+	/** Returns the worksheet id that owns this image. */
+	getSubUnitId() {
+		return this._image.subUnitId;
+	}
 	/**
 	* Get the drawing type of the image
 	* @returns {DrawingTypeEnum} The drawing type of the image
@@ -771,11 +805,12 @@ let FOverGridImage = class FOverGridImage extends _univerjs_core_facade.FBase {
 	* ```
 	*/
 	getPlacement() {
-		return (0, _univerjs_sheets_drawing.getSheetDrawingPlacement)(this._sheetDrawingService.getDrawingByParam({
+		const current = this._sheetDrawingService.getDrawingByParam({
 			unitId: this._image.unitId,
 			subUnitId: this._image.subUnitId,
 			drawingId: this._image.drawingId
-		}) ?? this._image);
+		});
+		return (0, _univerjs_sheets_drawing.getSheetDrawingPlacement)(current ?? this._image);
 	}
 	/**
 	* Set this image's explicit placement through the drawing command.
@@ -896,7 +931,7 @@ let FOverGridImage = class FOverGridImage extends _univerjs_core_facade.FBase {
 	* Set the size of the image
 	* @param {number} width - The width of the image, pixel unit
 	* @param {number} height - The height of the image, pixel unit
-	* @returns {boolean} true if the size is set successfully, otherwise false
+	* @returns {Promise<boolean>} A promise resolving to whether the image update succeeded.
 	* @example
 	* ```ts
 	* // set the image width 120px and height 50px
@@ -904,7 +939,7 @@ let FOverGridImage = class FOverGridImage extends _univerjs_core_facade.FBase {
 	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
 	* if (!fWorksheet) return;
 	* const image = fWorksheet.getImages()[0];
-	* const result = image?.setSizeAsync(120, 50);
+	* const result = await image?.setSizeAsync(120, 50);
 	* console.log(result);
 	* ```
 	*/
@@ -920,10 +955,10 @@ let FOverGridImage = class FOverGridImage extends _univerjs_core_facade.FBase {
 	}
 	/**
 	* Set the cropping region of the image by defining the top, bottom, left, and right edges, thereby displaying the specific part of the image you want.
-	* @param {number} top - The number of pixels to crop from the top of the image
-	* @param {number} left - The number of pixels to crop from the left side of the image
-	* @param {number} bottom - The number of pixels to crop from the bottom of the image
-	* @param {number} right - The number of pixels to crop from the right side of the image
+	* @param {number} [top] - The number of pixels to crop from the top of the image
+	* @param {number} [left] - The number of pixels to crop from the left side of the image
+	* @param {number} [bottom] - The number of pixels to crop from the bottom of the image
+	* @param {number} [right] - The number of pixels to crop from the right side of the image
 	* @returns {boolean} true if the crop is set successfully, otherwise false
 	* @example
 	* ```ts
@@ -1075,10 +1110,37 @@ FOverGridImage = __decorate([
 //#endregion
 //#region src/facade/f-worksheet.ts
 var FWorksheetDrawingMixin = class extends _univerjs_sheets_facade.FWorksheet {
-	_initialize(injector) {
-		this._sheetDrawingService = injector.get(_univerjs_sheets_drawing.ISheetDrawingService);
-		this._sheetSkeletonService = injector.get(_univerjs_sheets.SheetSkeletonService);
-		this._undoRedoService = injector.get(_univerjs_core.IUndoRedoService);
+	get _sheetDrawingService() {
+		return this._injector.get(_univerjs_sheets_drawing.ISheetDrawingService);
+	}
+	get _sheetSkeletonService() {
+		return this._injector.get(_univerjs_sheets.SheetSkeletonService);
+	}
+	get _undoRedoService() {
+		return this._injector.get(_univerjs_core.IUndoRedoService);
+	}
+	getBackgroundImage() {
+		const backgroundImage = this._worksheet.getConfig().backgroundImage;
+		return backgroundImage ? { ...backgroundImage } : null;
+	}
+	setBackgroundImage(source, imageSourceType = _univerjs_core.ImageSourceType.URL) {
+		this._commandService.syncExecuteCommand(_univerjs_sheets_drawing.SetWorksheetBackgroundImageCommand.id, {
+			unitId: this._fWorkbook.getId(),
+			subUnitId: this.getSheetId(),
+			backgroundImage: {
+				source,
+				imageSourceType
+			}
+		});
+		return this;
+	}
+	deleteBackgroundImage() {
+		this._commandService.syncExecuteCommand(_univerjs_sheets_drawing.SetWorksheetBackgroundImageCommand.id, {
+			unitId: this._fWorkbook.getId(),
+			subUnitId: this.getSheetId(),
+			backgroundImage: null
+		});
+		return this;
 	}
 	async insertImage(url, column, row, offsetX, offsetY) {
 		const imageBuilder = this.newOverGridImage();
@@ -1663,4 +1725,10 @@ var FUniverSheetsDrawingMixin = class extends _univerjs_core_facade.FUniver {
 };
 _univerjs_core_facade.FUniver.extend(FUniverSheetsDrawingMixin);
 
-//#endregion
+//#endregion
+Object.defineProperty(exports, 'FOverGridImage', {
+  enumerable: true,
+  get: function () {
+    return FOverGridImage;
+  }
+});