@univerjs/sheets-drawing 0.18.0 → 0.19.0-insiders.20260403-3e0e122
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/lib/cjs/facade.js +1 -0
- package/lib/cjs/index.js +1 -1
- package/lib/es/facade.js +1 -0
- package/lib/es/index.js +1 -1
- package/lib/facade.js +1 -0
- package/lib/index.js +1 -1
- package/lib/types/basics/transform-position.d.ts +31 -0
- package/lib/types/commands/commands/insert-sheet-drawing.command.d.ts +22 -0
- package/lib/types/commands/commands/remove-sheet-drawing.command.d.ts +27 -0
- package/lib/types/commands/commands/set-drawing-arrange.command.d.ts +22 -0
- package/lib/types/commands/commands/set-sheet-drawing.command.d.ts +22 -0
- package/lib/types/commands/operations/clear-drawing-transformer.operation.d.ts +17 -0
- package/lib/types/controllers/sheet-drawing.controller.d.ts +1 -0
- package/lib/types/facade/f-enum.d.ts +38 -0
- package/lib/types/facade/f-event.d.ts +374 -0
- package/lib/types/facade/f-over-grid-image.d.ts +603 -0
- package/lib/types/facade/f-univer.d.ts +27 -0
- package/lib/types/facade/f-worksheet.d.ts +213 -0
- package/lib/types/facade/index.d.ts +25 -0
- package/lib/types/index.d.ts +6 -0
- package/lib/umd/facade.js +1 -0
- package/lib/umd/index.js +1 -1
- package/package.json +18 -7
- package/LICENSE +0 -176
|
@@ -0,0 +1,374 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright 2023-present DreamNum Co., Ltd.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import type { IDrawingSearch } from '@univerjs/core';
|
|
17
|
+
import type { IEventBase } from '@univerjs/core/facade';
|
|
18
|
+
import type { ISheetImage } from '@univerjs/sheets-drawing';
|
|
19
|
+
import type { FWorkbook } from '@univerjs/sheets/facade';
|
|
20
|
+
import type { FOverGridImage } from './f-over-grid-image';
|
|
21
|
+
import { FEventName } from '@univerjs/core/facade';
|
|
22
|
+
/**
|
|
23
|
+
* @ignore
|
|
24
|
+
*/
|
|
25
|
+
interface IFSheetsDrawingEventNameMixin {
|
|
26
|
+
/**
|
|
27
|
+
* Triggered before float dom insertion.
|
|
28
|
+
* @see {@link IBeforeFloatDomAddParam}
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeFloatDomAdd, (params) => {
|
|
32
|
+
* console.log(params);
|
|
33
|
+
* // do something
|
|
34
|
+
* const { workbook, drawings } = params;
|
|
35
|
+
* // Cancel the insertion operation
|
|
36
|
+
* params.cancel = true;
|
|
37
|
+
* })
|
|
38
|
+
*
|
|
39
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
readonly BeforeFloatDomAdd: 'BeforeFloatDomAdd';
|
|
43
|
+
/**
|
|
44
|
+
* Triggered after float dom insertion.
|
|
45
|
+
* @see {@link IFloatDomAddedParam}
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.FloatDomAdded, (params) => {
|
|
49
|
+
* console.log(params);
|
|
50
|
+
* // do something
|
|
51
|
+
* const { workbook, drawings } = params;
|
|
52
|
+
* })
|
|
53
|
+
*
|
|
54
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
readonly FloatDomAdded: 'FloatDomAdded';
|
|
58
|
+
/**
|
|
59
|
+
* Triggered before float dom update.
|
|
60
|
+
* @see {@link IBeforeFloatDomUpdateParam}
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeFloatDomUpdate, (params) => {
|
|
64
|
+
* console.log(params);
|
|
65
|
+
* // do something
|
|
66
|
+
* const { workbook, drawings } = params;
|
|
67
|
+
* // Cancel the update operation
|
|
68
|
+
* params.cancel = true;
|
|
69
|
+
* })
|
|
70
|
+
*
|
|
71
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
readonly BeforeFloatDomUpdate: 'BeforeFloatDomUpdate';
|
|
75
|
+
/**
|
|
76
|
+
* Triggered after float dom update.
|
|
77
|
+
* @see {@link IFloatDomUpdatedParam}
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.FloatDomUpdated, (params) => {
|
|
81
|
+
* console.log(params);
|
|
82
|
+
* // do something
|
|
83
|
+
* const { workbook, drawings } = params;
|
|
84
|
+
* })
|
|
85
|
+
*
|
|
86
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
readonly FloatDomUpdated: 'FloatDomUpdated';
|
|
90
|
+
/**
|
|
91
|
+
* Triggered before float dom deletion.
|
|
92
|
+
* @see {@link IBeforeFloatDomDeleteParam}
|
|
93
|
+
* @example
|
|
94
|
+
* ```ts
|
|
95
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeFloatDomDelete, (params) => {
|
|
96
|
+
* console.log(params);
|
|
97
|
+
* // do something
|
|
98
|
+
* const { workbook, drawings } = params;
|
|
99
|
+
* // Cancel the deletion operation
|
|
100
|
+
* params.cancel = true;
|
|
101
|
+
* })
|
|
102
|
+
*
|
|
103
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
104
|
+
* ```
|
|
105
|
+
*/
|
|
106
|
+
readonly BeforeFloatDomDelete: 'BeforeFloatDomDelete';
|
|
107
|
+
/**
|
|
108
|
+
* Triggered after float dom deletion.
|
|
109
|
+
* @see {@link IFloatDomDeletedParam}
|
|
110
|
+
* @example
|
|
111
|
+
* ```ts
|
|
112
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.FloatDomDeleted, (params) => {
|
|
113
|
+
* console.log(params);
|
|
114
|
+
* // do something
|
|
115
|
+
* const { workbook, drawings } = params;
|
|
116
|
+
* })
|
|
117
|
+
*
|
|
118
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
readonly FloatDomDeleted: 'FloatDomDeleted';
|
|
122
|
+
/**
|
|
123
|
+
* Triggered before floating image insertion.
|
|
124
|
+
* @see {@link IBeforeOverGridImageInsertEventParams}
|
|
125
|
+
* @example
|
|
126
|
+
* ```ts
|
|
127
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageInsert, (params) => {
|
|
128
|
+
* console.log(params);
|
|
129
|
+
* // do something
|
|
130
|
+
* const { workbook, insertImageParams } = params;
|
|
131
|
+
* // Cancel the insertion operation
|
|
132
|
+
* params.cancel = true;
|
|
133
|
+
* })
|
|
134
|
+
*
|
|
135
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
readonly BeforeOverGridImageInsert: 'BeforeOverGridImageInsert';
|
|
139
|
+
/**
|
|
140
|
+
* Triggered after floating image insertion.
|
|
141
|
+
* @see {@link IOverGridImageInsertedEventParams}
|
|
142
|
+
* @example
|
|
143
|
+
* ```ts
|
|
144
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageInserted, (params) => {
|
|
145
|
+
* console.log(params);
|
|
146
|
+
* // do something
|
|
147
|
+
* const { workbook, images } = params;
|
|
148
|
+
* })
|
|
149
|
+
*
|
|
150
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
151
|
+
* ```
|
|
152
|
+
*/
|
|
153
|
+
readonly OverGridImageInserted: 'OverGridImageInserted';
|
|
154
|
+
/**
|
|
155
|
+
* Triggered before floating image removal.
|
|
156
|
+
* @see {@link IBeforeOverGridImageRemoveEventParams}
|
|
157
|
+
* @example
|
|
158
|
+
* ```ts
|
|
159
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageRemove, (params) => {
|
|
160
|
+
* console.log(params);
|
|
161
|
+
* // do something
|
|
162
|
+
* const { workbook, images } = params;
|
|
163
|
+
* // Cancel the removal operation
|
|
164
|
+
* params.cancel = true;
|
|
165
|
+
* })
|
|
166
|
+
*
|
|
167
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
168
|
+
* ```
|
|
169
|
+
*/
|
|
170
|
+
readonly BeforeOverGridImageRemove: 'BeforeOverGridImageRemove';
|
|
171
|
+
/**
|
|
172
|
+
* Triggered after floating image removal.
|
|
173
|
+
* @see {@link IOverGridImageRemovedEventParams}
|
|
174
|
+
* @example
|
|
175
|
+
* ```ts
|
|
176
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageRemoved, (params) => {
|
|
177
|
+
* console.log(params);
|
|
178
|
+
* // do something
|
|
179
|
+
* const { workbook, removeImageParams } = params;
|
|
180
|
+
* })
|
|
181
|
+
*
|
|
182
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
183
|
+
* ```
|
|
184
|
+
*/
|
|
185
|
+
readonly OverGridImageRemoved: 'OverGridImageRemoved';
|
|
186
|
+
/**
|
|
187
|
+
* Triggered before floating image change.
|
|
188
|
+
* @see {@link IBeforeOverGridImageChangeEventParams}
|
|
189
|
+
* @example
|
|
190
|
+
* ```ts
|
|
191
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageChange, (params) => {
|
|
192
|
+
* console.log(params);
|
|
193
|
+
* // do something
|
|
194
|
+
* const { workbook, images } = params;
|
|
195
|
+
* // Cancel the image change
|
|
196
|
+
* params.cancel = true;
|
|
197
|
+
* })
|
|
198
|
+
*
|
|
199
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
readonly BeforeOverGridImageChange: 'BeforeOverGridImageChange';
|
|
203
|
+
/**
|
|
204
|
+
* Triggered after floating image change.
|
|
205
|
+
* @see {@link IOverGridImageChangedEventParams}
|
|
206
|
+
* @example
|
|
207
|
+
* ```ts
|
|
208
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageChanged, (params) => {
|
|
209
|
+
* console.log(params);
|
|
210
|
+
* // do something
|
|
211
|
+
* const { workbook, images } = params;
|
|
212
|
+
* })
|
|
213
|
+
*
|
|
214
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
215
|
+
* ```
|
|
216
|
+
*/
|
|
217
|
+
readonly OverGridImageChanged: 'OverGridImageChanged';
|
|
218
|
+
/**
|
|
219
|
+
* Triggered before floating image selection.
|
|
220
|
+
* @see {@link IBeforeOverGridImageSelectEventParams}
|
|
221
|
+
* @example
|
|
222
|
+
* ```ts
|
|
223
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageSelect, (params) => {
|
|
224
|
+
* console.log(params);
|
|
225
|
+
* // do something
|
|
226
|
+
* const { workbook, selectedImages, oldSelectedImages } = params;
|
|
227
|
+
* // cancel the selection operation
|
|
228
|
+
* params.cancel = true;
|
|
229
|
+
* })
|
|
230
|
+
*
|
|
231
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
232
|
+
* ```
|
|
233
|
+
*/
|
|
234
|
+
readonly BeforeOverGridImageSelect: 'BeforeOverGridImageSelect';
|
|
235
|
+
/**
|
|
236
|
+
* Triggered after floating image selection.
|
|
237
|
+
* @see {@link IOverGridImageSelectedEventParams}
|
|
238
|
+
* @example
|
|
239
|
+
* ```ts
|
|
240
|
+
* const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageSelected, (params) => {
|
|
241
|
+
* console.log(params);
|
|
242
|
+
* // do something
|
|
243
|
+
* const { workbook, selectedImages } = params;
|
|
244
|
+
* })
|
|
245
|
+
*
|
|
246
|
+
* // Remove the event listener, use `disposable.dispose()`
|
|
247
|
+
* ```
|
|
248
|
+
*/
|
|
249
|
+
readonly OverGridImageSelected: 'OverGridImageSelected';
|
|
250
|
+
}
|
|
251
|
+
export declare class FSheetsDrawingEventNameMixin extends FEventName implements IFSheetsDrawingEventNameMixin {
|
|
252
|
+
get BeforeFloatDomAdd(): 'BeforeFloatDomAdd';
|
|
253
|
+
get FloatDomAdded(): 'FloatDomAdded';
|
|
254
|
+
get BeforeFloatDomUpdate(): 'BeforeFloatDomUpdate';
|
|
255
|
+
get FloatDomUpdated(): 'FloatDomUpdated';
|
|
256
|
+
get BeforeFloatDomDelete(): 'BeforeFloatDomDelete';
|
|
257
|
+
get FloatDomDeleted(): 'FloatDomDeleted';
|
|
258
|
+
get BeforeOverGridImageChange(): 'BeforeOverGridImageChange';
|
|
259
|
+
get OverGridImageChanged(): 'OverGridImageChanged';
|
|
260
|
+
get BeforeOverGridImageInsert(): 'BeforeOverGridImageInsert';
|
|
261
|
+
get OverGridImageInserted(): 'OverGridImageInserted';
|
|
262
|
+
get BeforeOverGridImageRemove(): 'BeforeOverGridImageRemove';
|
|
263
|
+
get OverGridImageRemoved(): 'OverGridImageRemoved';
|
|
264
|
+
get BeforeOverGridImageSelect(): 'BeforeOverGridImageSelect';
|
|
265
|
+
get OverGridImageSelected(): 'OverGridImageSelected';
|
|
266
|
+
}
|
|
267
|
+
export interface IBeforeOverGridImageChangeParamObject {
|
|
268
|
+
/**
|
|
269
|
+
* Parameters of the image to be updated. {@link ISheetImage}
|
|
270
|
+
*/
|
|
271
|
+
changeParam: Partial<ISheetImage>;
|
|
272
|
+
/**
|
|
273
|
+
* Instance of the image to be updated. {@link FOverGridImage}
|
|
274
|
+
*/
|
|
275
|
+
image: FOverGridImage;
|
|
276
|
+
}
|
|
277
|
+
export interface IBeforeOverGridImageChangeEventParams extends IEventBase {
|
|
278
|
+
/**
|
|
279
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
280
|
+
*/
|
|
281
|
+
workbook: FWorkbook;
|
|
282
|
+
/**
|
|
283
|
+
* Collection of parameters of the images to be updated, there may be multiple images to be updated. {@link IBeforeOverGridImageChangeParamObject}
|
|
284
|
+
*/
|
|
285
|
+
images: IBeforeOverGridImageChangeParamObject[];
|
|
286
|
+
}
|
|
287
|
+
export interface IOverGridImageChangedEventParams extends IEventBase {
|
|
288
|
+
/**
|
|
289
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
290
|
+
*/
|
|
291
|
+
workbook: FWorkbook;
|
|
292
|
+
/**
|
|
293
|
+
* Instances of the images after the update. {@link FOverGridImage}
|
|
294
|
+
*/
|
|
295
|
+
images: FOverGridImage[];
|
|
296
|
+
}
|
|
297
|
+
export interface IBeforeOverGridImageInsertEventParams extends IEventBase {
|
|
298
|
+
/**
|
|
299
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
300
|
+
*/
|
|
301
|
+
workbook: FWorkbook;
|
|
302
|
+
/**
|
|
303
|
+
* Collection of parameters of the images to be inserted. {@link ISheetImage}
|
|
304
|
+
*/
|
|
305
|
+
insertImageParams: ISheetImage[];
|
|
306
|
+
}
|
|
307
|
+
export interface IOverGridImageInsertedEventParams extends IEventBase {
|
|
308
|
+
/**
|
|
309
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
310
|
+
*/
|
|
311
|
+
workbook: FWorkbook;
|
|
312
|
+
/**
|
|
313
|
+
* Collection of instances of the images after insertion. {@link FOverGridImage}
|
|
314
|
+
*/
|
|
315
|
+
images: FOverGridImage[];
|
|
316
|
+
}
|
|
317
|
+
export interface IBeforeOverGridImageRemoveEventParams extends IEventBase {
|
|
318
|
+
/**
|
|
319
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
320
|
+
*/
|
|
321
|
+
workbook: FWorkbook;
|
|
322
|
+
/**
|
|
323
|
+
* Collection of instances of the images to be removed. {@link FOverGridImage}
|
|
324
|
+
*/
|
|
325
|
+
images: FOverGridImage[];
|
|
326
|
+
}
|
|
327
|
+
export interface IOverGridImageRemovedEventParams extends IEventBase {
|
|
328
|
+
/**
|
|
329
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
330
|
+
*/
|
|
331
|
+
workbook: FWorkbook;
|
|
332
|
+
/**
|
|
333
|
+
* Collection of parameters of the images after removal. {@link ISheetImage}
|
|
334
|
+
*/
|
|
335
|
+
removeImageParams: IDrawingSearch[];
|
|
336
|
+
}
|
|
337
|
+
export interface IBeforeOverGridImageSelectEventParams extends IEventBase {
|
|
338
|
+
/**
|
|
339
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
340
|
+
*/
|
|
341
|
+
workbook: FWorkbook;
|
|
342
|
+
/**
|
|
343
|
+
* The images before selection. {@link FOverGridImage}
|
|
344
|
+
*/
|
|
345
|
+
oldSelectedImages: FOverGridImage[];
|
|
346
|
+
selectedImages: FOverGridImage[];
|
|
347
|
+
}
|
|
348
|
+
export interface IOverGridImageSelectedEventParams extends IEventBase {
|
|
349
|
+
/**
|
|
350
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
351
|
+
*/
|
|
352
|
+
workbook: FWorkbook;
|
|
353
|
+
/**
|
|
354
|
+
* The selected images. {@link FOverGridImage}
|
|
355
|
+
*/
|
|
356
|
+
selectedImages: FOverGridImage[];
|
|
357
|
+
}
|
|
358
|
+
interface ISheetsDrawingEventParamConfig {
|
|
359
|
+
BeforeOverGridImageChange: IBeforeOverGridImageChangeEventParams;
|
|
360
|
+
OverGridImageChanged: IOverGridImageChangedEventParams;
|
|
361
|
+
BeforeOverGridImageInsert: IBeforeOverGridImageInsertEventParams;
|
|
362
|
+
OverGridImageInserted: IOverGridImageInsertedEventParams;
|
|
363
|
+
BeforeOverGridImageRemove: IBeforeOverGridImageRemoveEventParams;
|
|
364
|
+
OverGridImageRemoved: IOverGridImageRemovedEventParams;
|
|
365
|
+
BeforeOverGridImageSelect: IBeforeOverGridImageSelectEventParams;
|
|
366
|
+
OverGridImageSelected: IOverGridImageSelectedEventParams;
|
|
367
|
+
}
|
|
368
|
+
declare module '@univerjs/core/facade' {
|
|
369
|
+
interface FEventName extends IFSheetsDrawingEventNameMixin {
|
|
370
|
+
}
|
|
371
|
+
interface IEventParamConfig extends ISheetsDrawingEventParamConfig {
|
|
372
|
+
}
|
|
373
|
+
}
|
|
374
|
+
export {};
|