@univerjs/sheets-drawing 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,9 +8,9 @@
8
8
 
9
9
  ## Package Overview
10
10
 
11
- | Package | UMD global | CSS | Locales | Facade entry |
12
- | --- | --- | :---: | :---: | :---: |
13
- | `@univerjs/sheets-drawing` | `UniverSheetsDrawing` | No | No | Yes |
11
+ | Package | UMD global | CSS | Locales | Facade entry | Worker entry |
12
+ | --- | --- | :---: | :---: | :---: | :---: |
13
+ | `@univerjs/sheets-drawing` | `UniverSheetsDrawing` | No | No | Yes | No |
14
14
 
15
15
  ## Installation
16
16
 
@@ -20,10 +20,10 @@ pnpm add @univerjs/sheets-drawing
20
20
  npm install @univerjs/sheets-drawing
21
21
  ```
22
22
 
23
- Keep all `@univerjs/*` packages on the same version.
24
-
25
23
  ## Usage
26
24
 
25
+ Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
26
+
27
27
  ```ts
28
28
  import { UniverSheetsDrawingPlugin } from '@univerjs/sheets-drawing';
29
29
 
@@ -33,6 +33,7 @@ univer.registerPlugin(UniverSheetsDrawingPlugin);
33
33
  ## Integration Notes
34
34
 
35
35
  Use this package with `@univerjs/sheets-drawing-ui` when users need drawing interactions in the sheet UI.
36
+ - Import `@univerjs/sheets-drawing/facade` when using this package through Univer Facade APIs.
36
37
 
37
38
  ## Resources
38
39
 
package/lib/cjs/facade.js CHANGED
@@ -7,7 +7,7 @@ let _univerjs_sheets_drawing = require("@univerjs/sheets-drawing");
7
7
  let _univerjs_engine_render = require("@univerjs/engine-render");
8
8
  let _univerjs_sheets_facade = require("@univerjs/sheets/facade");
9
9
 
10
- // \0@oxc-project+runtime@0.156.0/helpers/esm/typeof.js
10
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/typeof.js
11
11
  function _typeof(o) {
12
12
  "@babel/helpers - typeof";
13
13
  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -17,25 +17,25 @@ function _typeof(o) {
17
17
  }, _typeof(o);
18
18
  }
19
19
 
20
- // \0@oxc-project+runtime@0.156.0/helpers/esm/toPrimitive.js
21
- function toPrimitive(t, r) {
20
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/toPrimitive.js
21
+ function toPrimitive(t, e) {
22
22
  if ("object" != _typeof(t) || !t) return t;
23
- var e = t[Symbol.toPrimitive];
24
- if (void 0 !== e) {
25
- var i = e.call(t, r || "default");
23
+ var r;
24
+ if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) {
25
+ var i = r.call(t, e || "default");
26
26
  if ("object" != _typeof(i)) return i;
27
27
  throw new TypeError("@@toPrimitive must return a primitive value.");
28
28
  }
29
- return ("string" === r ? String : Number)(t);
29
+ return ("string" === e ? String : Number)(t);
30
30
  }
31
31
 
32
- // \0@oxc-project+runtime@0.156.0/helpers/esm/toPropertyKey.js
32
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/toPropertyKey.js
33
33
  function toPropertyKey(t) {
34
34
  var i = toPrimitive(t, "string");
35
35
  return "symbol" == _typeof(i) ? i : i + "";
36
36
  }
37
37
 
38
- // \0@oxc-project+runtime@0.156.0/helpers/esm/defineProperty.js
38
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/defineProperty.js
39
39
  function _defineProperty(e, r, t) {
40
40
  return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
41
41
  value: t,
@@ -45,14 +45,14 @@ function _defineProperty(e, r, t) {
45
45
  }) : e[r] = t, e;
46
46
  }
47
47
 
48
- // \0@oxc-project+runtime@0.156.0/helpers/esm/decorateParam.js
48
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/decorateParam.js
49
49
  function __decorateParam(paramIndex, decorator) {
50
50
  return function(target, key) {
51
51
  decorator(target, key, paramIndex);
52
52
  };
53
53
  }
54
54
 
55
- // \0@oxc-project+runtime@0.156.0/helpers/esm/decorate.js
55
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/decorate.js
56
56
  function __decorate(decorators, target, key, desc) {
57
57
  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
58
58
  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -910,6 +910,10 @@ let FOverGridImage = class FOverGridImage extends _univerjs_core_facade.FBase {
910
910
  }
911
911
  /**
912
912
  * Remove the image from the sheet
913
+ *
914
+ * For multiple images on the same worksheet, prefer {@link FWorksheet.deleteImages} with the image
915
+ * handles instead of calling this method on each image.
916
+ *
913
917
  * @returns {boolean} true if the image is removed successfully, otherwise false
914
918
  * @example
915
919
  * ```ts
package/lib/cjs/index.js CHANGED
@@ -215,6 +215,32 @@ const InsertSheetDrawingCommand = {
215
215
  };
216
216
 
217
217
  // src/commands/commands/remove-sheet-drawing.command.ts
218
+ function expandDrawingRemovalParams(service, requested) {
219
+ const drawings = [];
220
+ const visit = (search, ancestors) => {
221
+ if (ancestors.has(search.drawingId)) throw new _univerjs_core.CustomCommandExecutionError(RemoveSheetDrawingCommand.id);
222
+ if (drawings.some((drawing) => drawing.unitId === search.unitId && drawing.subUnitId === search.subUnitId && drawing.drawingId === search.drawingId)) return;
223
+ const current = service.getDrawingByParam(search);
224
+ drawings.push({
225
+ unitId: search.unitId,
226
+ subUnitId: search.subUnitId,
227
+ drawingId: search.drawingId,
228
+ drawingType: (current === null || current === void 0 ? void 0 : current.drawingType) ?? search.drawingType
229
+ });
230
+ if (!current) return;
231
+ const children = Object.values(service.getDrawingData(search.unitId, search.subUnitId)).filter((drawing) => current.drawingType === _univerjs_core.DrawingTypeEnum.DRAWING_GROUP && drawing.groupId === search.drawingId);
232
+ const nextAncestors = new Set(ancestors);
233
+ nextAncestors.add(search.drawingId);
234
+ children.forEach((drawing) => visit({
235
+ unitId: search.unitId,
236
+ subUnitId: search.subUnitId,
237
+ drawingId: drawing.drawingId,
238
+ drawingType: drawing.drawingType
239
+ }, nextAncestors));
240
+ };
241
+ requested.forEach((drawing) => visit(drawing, /* @__PURE__ */ new Set()));
242
+ return drawings;
243
+ }
218
244
  const RemoveSheetDrawingCommand = {
219
245
  id: "sheet.command.remove-sheet-image",
220
246
  type: _univerjs_core.CommandType.COMMAND,
@@ -224,13 +250,20 @@ const RemoveSheetDrawingCommand = {
224
250
  const undoRedoService = accessor.get(_univerjs_core.IUndoRedoService);
225
251
  const sheetInterceptorService = accessor.get(_univerjs_sheets.SheetInterceptorService);
226
252
  const sheetDrawingService = accessor.get(ISheetDrawingService);
227
- const { drawings } = params;
228
- const { unitId, subUnitId, undo, redo, objects } = sheetDrawingService.getBatchRemoveOp(drawings);
229
- if (Array.isArray(objects) && objects.length === 0) return false;
253
+ const normalizedParams = {
254
+ ...params,
255
+ drawings: expandDrawingRemovalParams(sheetDrawingService, params.drawings)
256
+ };
257
+ if (!accessor.get(_univerjs_drawing.IDrawingManagerService).canExecuteCommand({
258
+ id: RemoveSheetDrawingCommand.id,
259
+ params: normalizedParams
260
+ })) return false;
230
261
  const intercepted = sheetInterceptorService.onCommandExecute({
231
262
  id: RemoveSheetDrawingCommand.id,
232
- params
263
+ params: normalizedParams
233
264
  });
265
+ const { unitId, subUnitId, undo, redo, objects } = sheetDrawingService.getBatchRemoveOp(normalizedParams.drawings);
266
+ if (Array.isArray(objects) && objects.length === 0) return false;
234
267
  const redoMutations = [
235
268
  ...intercepted.preRedos ?? [],
236
269
  {
@@ -373,6 +406,47 @@ function getSheetDrawingPlacement(drawing) {
373
406
  function applySheetDrawingPlacement(drawing, input, skeleton) {
374
407
  return resolveSheetDrawingPlacement(drawing, normalizePlacement(input, skeleton, requiresDrawingArea(drawing)), skeleton);
375
408
  }
409
+ /** Place a batch at the logical start corner of a Chart Sheet, preserving its relative geometry. */
410
+ function transformDrawingsToChartSheet(drawings, chartSheetBounds, rightToLeft) {
411
+ if (validateBounds(chartSheetBounds, true)) return null;
412
+ if (!drawings.length) return [];
413
+ const bounds = [];
414
+ for (const drawing of drawings) {
415
+ const state = drawing.transform;
416
+ if (!state || validateBounds(state, requiresDrawingArea(drawing)) || [
417
+ state.angle,
418
+ state.skewX,
419
+ state.skewY,
420
+ state.scaleX,
421
+ state.scaleY
422
+ ].some((value) => value !== void 0 && !Number.isFinite(value))) return null;
423
+ const { width = 0, height = 0, angle = 0 } = state;
424
+ const matrix = _univerjs_engine_render.Transform.create().composeMatrix(state);
425
+ if (angle) matrix.rotate(-angle).translate(width / 2, height / 2).rotate(angle).translate(-width / 2, -height / 2);
426
+ const box = matrix.makeBoundingBoxFromPoints([
427
+ new _univerjs_engine_render.Vector2(0, 0),
428
+ new _univerjs_engine_render.Vector2(width, 0),
429
+ new _univerjs_engine_render.Vector2(width, height),
430
+ new _univerjs_engine_render.Vector2(0, height)
431
+ ]);
432
+ bounds.push({
433
+ left: box.left,
434
+ top: box.top,
435
+ width: box.width,
436
+ height: box.height
437
+ });
438
+ }
439
+ const group = (0, _univerjs_engine_render.getGroupState)(0, 0, bounds);
440
+ const scale = Math.min(1, group.width ? chartSheetBounds.width / group.width : 1, group.height ? chartSheetBounds.height / group.height : 1);
441
+ const left = rightToLeft ? chartSheetBounds.left + chartSheetBounds.width - group.width * scale : chartSheetBounds.left;
442
+ return drawings.map((drawing) => applySheetDrawingPlacement(drawing, {
443
+ kind: "2",
444
+ left: left + (drawing.transform.left - group.left) * scale,
445
+ top: chartSheetBounds.top + (drawing.transform.top - group.top) * scale,
446
+ width: drawing.transform.width * scale,
447
+ height: drawing.transform.height * scale
448
+ }));
449
+ }
376
450
  /** Refresh layout-derived geometry without changing the drawing's anchor semantics. */
377
451
  function refreshSheetDrawingPlacement(drawing, skeleton) {
378
452
  const result = tryRefreshSheetDrawingPlacement(drawing, skeleton);
@@ -596,8 +670,11 @@ const SetSheetDrawingPlacementCommand = {
596
670
  type: _univerjs_core.CommandType.COMMAND,
597
671
  handler: (accessor, params) => {
598
672
  if (!(params === null || params === void 0 ? void 0 : params.drawings.length)) return false;
673
+ if (!accessor.get(_univerjs_drawing.IDrawingManagerService).canExecuteCommand({
674
+ id: SetSheetDrawingPlacementCommand.id,
675
+ params
676
+ })) return false;
599
677
  const commandService = accessor.get(_univerjs_core.ICommandService);
600
- const undoRedoService = accessor.get(_univerjs_core.IUndoRedoService);
601
678
  const drawingService = accessor.get(ISheetDrawingService);
602
679
  const skeleton = params.drawings.every(({ placement }) => placement.kind === "2") ? void 0 : accessor.get(_univerjs_sheets.SheetSkeletonService).ensureSkeleton(params.unitId, params.subUnitId);
603
680
  const updatedDrawings = [];
@@ -610,38 +687,52 @@ const SetSheetDrawingPlacementCommand = {
610
687
  if (!drawing) return false;
611
688
  updatedDrawings.push(applySheetDrawingPlacement(drawing, placement, skeleton));
612
689
  }
690
+ const intercepted = accessor.get(_univerjs_sheets.SheetInterceptorService).onCommandExecute({
691
+ id: SetSheetDrawingPlacementCommand.id,
692
+ params
693
+ });
613
694
  const { unitId, subUnitId, undo, redo, objects } = drawingService.getBatchUpdateOp(updatedDrawings);
614
- const redoMutations = [{
615
- id: SetDrawingApplyMutation.id,
616
- params: {
617
- unitId,
618
- subUnitId,
619
- op: redo,
620
- objects,
621
- type: 2
622
- }
623
- }, {
624
- id: ClearSheetDrawingTransformerOperation.id,
625
- params: [unitId]
626
- }];
627
- const undoMutations = [{
628
- id: SetDrawingApplyMutation.id,
629
- params: {
630
- unitId,
631
- subUnitId,
632
- op: undo,
633
- objects,
634
- type: 2
635
- }
636
- }, {
637
- id: ClearSheetDrawingTransformerOperation.id,
638
- params: [unitId]
639
- }];
695
+ const redoMutations = [
696
+ ...intercepted.preRedos ?? [],
697
+ {
698
+ id: SetDrawingApplyMutation.id,
699
+ params: {
700
+ unitId,
701
+ subUnitId,
702
+ op: redo,
703
+ objects,
704
+ type: 2
705
+ }
706
+ },
707
+ {
708
+ id: ClearSheetDrawingTransformerOperation.id,
709
+ params: [unitId]
710
+ },
711
+ ...intercepted.redos
712
+ ];
713
+ const undoMutations = [
714
+ ...intercepted.preUndos ?? [],
715
+ {
716
+ id: SetDrawingApplyMutation.id,
717
+ params: {
718
+ unitId,
719
+ subUnitId,
720
+ op: undo,
721
+ objects,
722
+ type: 2
723
+ }
724
+ },
725
+ {
726
+ id: ClearSheetDrawingTransformerOperation.id,
727
+ params: [unitId]
728
+ },
729
+ ...intercepted.undos
730
+ ];
640
731
  if (!(0, _univerjs_core.sequenceExecute)(redoMutations, commandService).result) return false;
641
- undoRedoService.pushUndoRedo({
732
+ accessor.get(_univerjs_core.IUndoRedoService).pushUndoRedo({
642
733
  unitID: unitId,
643
- undoMutations,
644
- redoMutations
734
+ redoMutations,
735
+ undoMutations
645
736
  });
646
737
  return true;
647
738
  }
@@ -713,6 +804,10 @@ const SetSheetDrawingCommand = {
713
804
  ...params,
714
805
  drawings: normalizedDrawings
715
806
  };
807
+ if (!accessor.get(_univerjs_drawing.IDrawingManagerService).canExecuteCommand({
808
+ id: SetSheetDrawingCommand.id,
809
+ params: normalizedParams
810
+ })) return false;
716
811
  const { unitId, subUnitId, undo, redo, objects } = sheetDrawingService.getBatchUpdateOp(normalizedDrawings);
717
812
  const intercepted = sheetInterceptorService.onCommandExecute({
718
813
  id: SetSheetDrawingCommand.id,
@@ -820,14 +915,14 @@ const SetWorksheetBackgroundImageCommand = {
820
915
  }
821
916
  };
822
917
 
823
- // \0@oxc-project+runtime@0.156.0/helpers/esm/decorateParam.js
918
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/decorateParam.js
824
919
  function __decorateParam(paramIndex, decorator) {
825
920
  return function(target, key) {
826
921
  decorator(target, key, paramIndex);
827
922
  };
828
923
  }
829
924
 
830
- // \0@oxc-project+runtime@0.156.0/helpers/esm/decorate.js
925
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/decorate.js
831
926
  function __decorate(decorators, target, key, desc) {
832
927
  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
833
928
  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -1009,7 +1104,7 @@ SheetsDrawingLoadController = __decorate([
1009
1104
 
1010
1105
  // package.json
1011
1106
  var name = "@univerjs/sheets-drawing";
1012
- var version = "1.4.0";
1107
+ var version = "1.5.0";
1013
1108
 
1014
1109
  // src/config/config.ts
1015
1110
  /**
@@ -1031,7 +1126,7 @@ const SHEETS_DRAWING_PLUGIN_CONFIG_KEY = "sheets-drawing.config";
1031
1126
  const configSymbol = Symbol(SHEETS_DRAWING_PLUGIN_CONFIG_KEY);
1032
1127
  const defaultPluginConfig = {};
1033
1128
 
1034
- // \0@oxc-project+runtime@0.156.0/helpers/esm/typeof.js
1129
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/typeof.js
1035
1130
  function _typeof(o) {
1036
1131
  "@babel/helpers - typeof";
1037
1132
  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -1041,25 +1136,25 @@ function _typeof(o) {
1041
1136
  }, _typeof(o);
1042
1137
  }
1043
1138
 
1044
- // \0@oxc-project+runtime@0.156.0/helpers/esm/toPrimitive.js
1045
- function toPrimitive(t, r) {
1139
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/toPrimitive.js
1140
+ function toPrimitive(t, e) {
1046
1141
  if ("object" != _typeof(t) || !t) return t;
1047
- var e = t[Symbol.toPrimitive];
1048
- if (void 0 !== e) {
1049
- var i = e.call(t, r || "default");
1142
+ var r;
1143
+ if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) {
1144
+ var i = r.call(t, e || "default");
1050
1145
  if ("object" != _typeof(i)) return i;
1051
1146
  throw new TypeError("@@toPrimitive must return a primitive value.");
1052
1147
  }
1053
- return ("string" === r ? String : Number)(t);
1148
+ return ("string" === e ? String : Number)(t);
1054
1149
  }
1055
1150
 
1056
- // \0@oxc-project+runtime@0.156.0/helpers/esm/toPropertyKey.js
1151
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/toPropertyKey.js
1057
1152
  function toPropertyKey(t) {
1058
1153
  var i = toPrimitive(t, "string");
1059
1154
  return "symbol" == _typeof(i) ? i : i + "";
1060
1155
  }
1061
1156
 
1062
- // \0@oxc-project+runtime@0.156.0/helpers/esm/defineProperty.js
1157
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/defineProperty.js
1063
1158
  function _defineProperty(e, r, t) {
1064
1159
  return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
1065
1160
  value: t,
@@ -2107,5 +2202,6 @@ exports.isKnownSheetNonRotatableDrawingType = isKnownSheetNonRotatableDrawingTyp
2107
2202
  exports.normalizeSheetDrawingPlacement = normalizeSheetDrawingPlacement;
2108
2203
  exports.refreshSheetDrawingPlacement = refreshSheetDrawingPlacement;
2109
2204
  exports.resolveSheetDrawingRotateEnabled = resolveSheetDrawingRotateEnabled;
2205
+ exports.transformDrawingsToChartSheet = transformDrawingsToChartSheet;
2110
2206
  exports.transformToAxisAlignPosition = transformToAxisAlignPosition;
2111
2207
  exports.transformToDrawingPosition = transformToDrawingPosition;
package/lib/es/facade.js CHANGED
@@ -6,7 +6,7 @@ import { DrawingApplyType, ISheetDrawingService, InsertSheetDrawingCommand, Remo
6
6
  import { getGroupState, transformObjectOutOfGroup } from "@univerjs/engine-render";
7
7
  import { FWorksheet } from "@univerjs/sheets/facade";
8
8
 
9
- // \0@oxc-project+runtime@0.156.0/helpers/esm/typeof.js
9
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/typeof.js
10
10
  function _typeof(o) {
11
11
  "@babel/helpers - typeof";
12
12
  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -16,25 +16,25 @@ function _typeof(o) {
16
16
  }, _typeof(o);
17
17
  }
18
18
 
19
- // \0@oxc-project+runtime@0.156.0/helpers/esm/toPrimitive.js
20
- function toPrimitive(t, r) {
19
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/toPrimitive.js
20
+ function toPrimitive(t, e) {
21
21
  if ("object" != _typeof(t) || !t) return t;
22
- var e = t[Symbol.toPrimitive];
23
- if (void 0 !== e) {
24
- var i = e.call(t, r || "default");
22
+ var r;
23
+ if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) {
24
+ var i = r.call(t, e || "default");
25
25
  if ("object" != _typeof(i)) return i;
26
26
  throw new TypeError("@@toPrimitive must return a primitive value.");
27
27
  }
28
- return ("string" === r ? String : Number)(t);
28
+ return ("string" === e ? String : Number)(t);
29
29
  }
30
30
 
31
- // \0@oxc-project+runtime@0.156.0/helpers/esm/toPropertyKey.js
31
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/toPropertyKey.js
32
32
  function toPropertyKey(t) {
33
33
  var i = toPrimitive(t, "string");
34
34
  return "symbol" == _typeof(i) ? i : i + "";
35
35
  }
36
36
 
37
- // \0@oxc-project+runtime@0.156.0/helpers/esm/defineProperty.js
37
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/defineProperty.js
38
38
  function _defineProperty(e, r, t) {
39
39
  return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
40
40
  value: t,
@@ -44,14 +44,14 @@ function _defineProperty(e, r, t) {
44
44
  }) : e[r] = t, e;
45
45
  }
46
46
 
47
- // \0@oxc-project+runtime@0.156.0/helpers/esm/decorateParam.js
47
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/decorateParam.js
48
48
  function __decorateParam(paramIndex, decorator) {
49
49
  return function(target, key) {
50
50
  decorator(target, key, paramIndex);
51
51
  };
52
52
  }
53
53
 
54
- // \0@oxc-project+runtime@0.156.0/helpers/esm/decorate.js
54
+ // \0@oxc-project+runtime@0.157.0/helpers/esm/decorate.js
55
55
  function __decorate(decorators, target, key, desc) {
56
56
  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
57
57
  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -909,6 +909,10 @@ let FOverGridImage = class FOverGridImage extends FBase {
909
909
  }
910
910
  /**
911
911
  * Remove the image from the sheet
912
+ *
913
+ * For multiple images on the same worksheet, prefer {@link FWorksheet.deleteImages} with the image
914
+ * handles instead of calling this method on each image.
915
+ *
912
916
  * @returns {boolean} true if the image is removed successfully, otherwise false
913
917
  * @example
914
918
  * ```ts