@univerjs/sheets-drawing-ui 0.6.0 → 0.6.1-nightly.202502211606

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.
Files changed (12) hide show
  1. package/lib/cjs/facade.js +1 -1
  2. package/lib/cjs/index.js +1 -1
  3. package/lib/es/facade.js +490 -352
  4. package/lib/es/index.js +584 -581
  5. package/lib/types/facade/f-event.d.ts +61 -45
  6. package/lib/types/facade/f-over-grid-image.d.ts +378 -217
  7. package/lib/types/facade/f-worksheet.d.ts +290 -131
  8. package/lib/types/services/canvas-float-dom-manager.service.d.ts +2 -2
  9. package/lib/umd/facade.js +1 -1
  10. package/lib/umd/index.js +1 -1
  11. package/package.json +17 -17
  12. package/LICENSE +0 -176
package/lib/types/facade/f-event.d.ts CHANGED
@@ -9,113 +9,129 @@ import { FOverGridImage } from './f-over-grid-image';
9
9
  interface IFDrawingEventNameMixin {
10
10
  /**
11
11
  * Triggered before floating image insertion.
12
- * Type of the event parameter is {@link IBeforeOverGridImageInsertParam}
12
+ * @see {@link IBeforeOverGridImageInsertParam}
13
13
  * @example
14
14
  * ```ts
15
- * univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageInsert, (param) => {
16
- * const { workbook, insertImageParams } = param;
17
- * // do something
18
- * console.log(workbook, insertImageParams);
19
- * // Cancel the insertion operation
20
- * param.cancel = true;
15
+ * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageInsert, (params) => {
16
+ * console.log(params);
17
+ * // do something
18
+ * const { workbook, insertImageParams } = params;
19
+ * // Cancel the insertion operation
20
+ * params.cancel = true;
21
21
  * })
22
+ *
23
+ * // Remove the event listener, use `disposable.dispose()`
22
24
  * ```
23
25
  */
24
26
  readonly BeforeOverGridImageInsert: 'BeforeOverGridImageInsert';
25
27
  /**
26
28
  * Triggered after floating image insertion.
27
- * Type of the event parameter is {@link IOverGridImageInsertedParam}
29
+ * @see {@link IOverGridImageInsertedParam}
28
30
  * @example
29
31
  * ```ts
30
- * univerAPI.addEvent(univerAPI.Event.OverGridImageInserted, (param) => {
31
- * const { workbook, images } = param;
32
- * // do something
33
- * console.log(workbook, images);
32
+ * const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageInserted, (params) => {
33
+ * console.log(params);
34
+ * // do something
35
+ * const { workbook, images } = params;
34
36
  * })
37
+ *
38
+ * // Remove the event listener, use `disposable.dispose()`
35
39
  * ```
36
40
  */
37
41
  readonly OverGridImageInserted: 'OverGridImageInserted';
38
42
  /**
39
43
  * Triggered before floating image removal.
40
- * Type of the event parameter is {@link IBeforeOverGridImageRemoveParam}
44
+ * @see {@link IBeforeOverGridImageRemoveParam}
41
45
  * @example
42
46
  * ```ts
43
- * univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageRemove, (param) => {
44
- * const { workbook, images } = param;
45
- * // do something
46
- * console.log(workbook, images);
47
- * // Cancel the removal operation
48
- * param.cancel = true;
47
+ * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageRemove, (params) => {
48
+ * console.log(params);
49
+ * // do something
50
+ * const { workbook, images } = params;
51
+ * // Cancel the removal operation
52
+ * params.cancel = true;
49
53
  * })
54
+ *
55
+ * // Remove the event listener, use `disposable.dispose()`
50
56
  * ```
51
57
  */
52
58
  readonly BeforeOverGridImageRemove: 'BeforeOverGridImageRemove';
53
59
  /**
54
60
  * Triggered after floating image removal.
55
- * Type of the event parameter is {@link IOverGridImageRemovedParam}
61
+ * @see {@link IOverGridImageRemovedParam}
56
62
  * @example
57
63
  * ```ts
58
- * univerAPI.addEvent(univerAPI.Event.OverGridImageRemoved, (param) => {
59
- * const { workbook, removeImageParams } = param;
60
- * // do something
61
- * console.log(workbook, removeImageParams);
64
+ * const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageRemoved, (params) => {
65
+ * console.log(params);
66
+ * // do something
67
+ * const { workbook, removeImageParams } = params;
62
68
  * })
69
+ *
70
+ * // Remove the event listener, use `disposable.dispose()`
63
71
  * ```
64
72
  */
65
73
  readonly OverGridImageRemoved: 'OverGridImageRemoved';
66
74
  /**
67
75
  * Triggered before floating image change.
68
- * Type of the event parameter is {@link IBeforeOverGridImageChangeParam}
76
+ * @see {@link IBeforeOverGridImageChangeParam}
69
77
  * @example
70
78
  * ```ts
71
- * univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageChange, (param) => {
72
- * const { workbook, images } = param;
79
+ * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageChange, (params) => {
80
+ * console.log(params);
73
81
  * // do something
74
- * console.log(workbook, images);
82
+ * const { workbook, images } = params;
75
83
  * // Cancel the image change
76
- * param.cancel = true;
84
+ * params.cancel = true;
77
85
  * })
86
+ *
87
+ * // Remove the event listener, use `disposable.dispose()`
78
88
  * ```
79
89
  */
80
90
  readonly BeforeOverGridImageChange: 'BeforeOverGridImageChange';
81
91
  /**
82
92
  * Triggered after floating image change.
83
- * Type of the event parameter is {@link IOverGridImageChangedParam}
93
+ * @see {@link IOverGridImageChangedParam}
84
94
  * @example
85
95
  * ```ts
86
- * univerAPI.addEvent(univerAPI.Event.OverGridImageChanged, (param) => {
87
- * const { workbook, images } = param;
88
- * // do something
89
- * console.log(workbook, images);
96
+ * const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageChanged, (params) => {
97
+ * console.log(params);
98
+ * // do something
99
+ * const { workbook, images } = params;
90
100
  * })
101
+ *
102
+ * // Remove the event listener, use `disposable.dispose()`
91
103
  * ```
92
104
  */
93
105
  readonly OverGridImageChanged: 'OverGridImageChanged';
94
106
  /**
95
107
  * Triggered before floating image selection.
96
- * Type of the event parameter is {@link IBeforeOverGridImageSelectParam}
108
+ * @see {@link IBeforeOverGridImageSelectParam}
97
109
  * @example
98
110
  * ```ts
99
- * univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageSelect, (param) => {
100
- * const { workbook, selectedImages, oldSelectedImages } = param;
111
+ * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageSelect, (params) => {
112
+ * console.log(params);
101
113
  * // do something
102
- * console.log(workbook, selectedImages, oldSelectedImages);
103
- * // cancel the event
104
- * param.cancel = true;
114
+ * const { workbook, selectedImages, oldSelectedImages } = params;
115
+ * // cancel the selection operation
116
+ * params.cancel = true;
105
117
  * })
118
+ *
119
+ * // Remove the event listener, use `disposable.dispose()`
106
120
  * ```
107
121
  */
108
122
  readonly BeforeOverGridImageSelect: 'BeforeOverGridImageSelect';
109
123
  /**
110
124
  * Triggered after floating image selection.
111
- * Type of the event parameter is {@link IOverGridImageSelectedParam}
125
+ * @see {@link IOverGridImageSelectedParam}
112
126
  * @example
113
127
  * ```ts
114
- * univerAPI.addEvent(univerAPI.Event.OverGridImageSelected, (param) => {
115
- * const { workbook, selectedImages } = param;
116
- * // do something
117
- * console.log(workbook, selectedImages);
128
+ * const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageSelected, (params) => {
129
+ * console.log(params);
130
+ * // do something
131
+ * const { workbook, selectedImages } = params;
118
132
  * })
133
+ *
134
+ * // Remove the event listener, use `disposable.dispose()`
119
135
  * ```
120
136
  */
121
137
  readonly OverGridImageSelected: 'OverGridImageSelected';