@univerjs/sheets-ui 0.19.0 → 0.20.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/lib/cjs/facade.js +1 -1
- package/lib/cjs/index.js +11 -11
- package/lib/es/facade.js +1 -1
- package/lib/es/index.js +11 -11
- package/lib/facade.js +1 -1
- package/lib/index.js +11 -11
- package/lib/types/common/utils.d.ts +1 -2
- package/lib/types/controllers/auto-height.controller.d.ts +7 -9
- package/lib/types/controllers/render-controllers/scroll.render-controller.d.ts +0 -1
- package/lib/types/facade/f-enum.d.ts +4 -3
- package/lib/types/facade/f-event.d.ts +228 -213
- package/lib/types/facade/f-workbook.d.ts +0 -2
- package/lib/types/facade/f-worksheet.d.ts +3 -3
- package/lib/types/index.d.ts +0 -3
- package/lib/types/services/clipboard/html-to-usm/converter.d.ts +1 -1
- package/lib/types/services/editor-bridge.service.d.ts +3 -2
- package/lib/types/services/mark-selection/mark-selection.service.d.ts +3 -1
- package/lib/types/services/selection/base-selection-render.service.d.ts +1 -9
- package/lib/types/services/sheet-skeleton-manager.service.d.ts +8 -40
- package/lib/umd/facade.js +1 -1
- package/lib/umd/index.js +11 -11
- package/package.json +12 -12
- package/lib/types/services/selection/util.d.ts +0 -34
- package/lib/types/services/utils/drawing-position-util.d.ts +0 -50
|
@@ -20,54 +20,107 @@ import type { CommandListenerSkeletonChange } from '@univerjs/sheets';
|
|
|
20
20
|
import type { IDragCellPosition } from '@univerjs/sheets-ui';
|
|
21
21
|
import type { FRange, FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
|
|
22
22
|
import type { KeyCode } from '@univerjs/ui';
|
|
23
|
+
import { FEventName } from '@univerjs/core/facade';
|
|
23
24
|
/**
|
|
24
|
-
* Event interface triggered
|
|
25
|
-
* @interface ISheetEditStartedEventParams
|
|
26
|
-
* @augments {IEventBase}
|
|
25
|
+
* Event interface triggered before clipboard content changes
|
|
27
26
|
*/
|
|
28
|
-
export interface
|
|
27
|
+
export interface IBeforeClipboardChangeEventParams extends IEventBase {
|
|
28
|
+
/**
|
|
29
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
30
|
+
*/
|
|
31
|
+
workbook: FWorkbook;
|
|
32
|
+
/**
|
|
33
|
+
* The worksheet instance currently being operated on. {@link FWorksheet}
|
|
34
|
+
*/
|
|
35
|
+
worksheet: FWorksheet;
|
|
36
|
+
/**
|
|
37
|
+
* Clipboard Text String
|
|
38
|
+
*/
|
|
39
|
+
text: string;
|
|
40
|
+
/**
|
|
41
|
+
* Clipboard HTML String
|
|
42
|
+
*/
|
|
43
|
+
html: string;
|
|
44
|
+
/**
|
|
45
|
+
* The sheet containing the content that was (copied/cut)
|
|
46
|
+
*/
|
|
47
|
+
fromSheet: FWorksheet;
|
|
48
|
+
/**
|
|
49
|
+
* The range containing the content that was (copied/cut)
|
|
50
|
+
*/
|
|
51
|
+
fromRange: FRange;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Event interface triggered after clipboard content changes
|
|
55
|
+
*/
|
|
56
|
+
export interface IClipboardChangedEventParams extends IBeforeClipboardChangeEventParams {
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Event interface triggered before pasting content from clipboard
|
|
60
|
+
*/
|
|
61
|
+
export interface IBeforeClipboardPasteEventParams extends IEventBase {
|
|
62
|
+
/**
|
|
63
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
64
|
+
*/
|
|
65
|
+
workbook: FWorkbook;
|
|
66
|
+
/**
|
|
67
|
+
* The worksheet instance currently being operated on. {@link FWorkbook}
|
|
68
|
+
*/
|
|
69
|
+
worksheet: FWorksheet;
|
|
70
|
+
/**
|
|
71
|
+
* Clipboard Text String
|
|
72
|
+
*/
|
|
73
|
+
text?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Clipboard HTML String
|
|
76
|
+
*/
|
|
77
|
+
html?: string;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Event interface triggered after pasting content from clipboard
|
|
81
|
+
*/
|
|
82
|
+
export interface IClipboardPastedEventParams extends IBeforeClipboardPasteEventParams {
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Event interface triggered before cell editing starts
|
|
86
|
+
*/
|
|
87
|
+
export interface IBeforeSheetEditStartEventParams extends IEventBase {
|
|
29
88
|
/** The workbook instance */
|
|
30
89
|
workbook: FWorkbook;
|
|
31
|
-
/** The worksheet
|
|
90
|
+
/** The worksheet to be edited */
|
|
32
91
|
worksheet: FWorksheet;
|
|
33
|
-
/** Row index of the
|
|
92
|
+
/** Row index of the cell to be edited */
|
|
34
93
|
row: number;
|
|
35
|
-
/** Column index of the
|
|
94
|
+
/** Column index of the cell to be edited */
|
|
36
95
|
column: number;
|
|
37
|
-
/** Type of input device event
|
|
96
|
+
/** Type of input device event triggering the edit */
|
|
38
97
|
eventType: DeviceInputEventType;
|
|
39
|
-
/** Optional keycode
|
|
98
|
+
/** Optional keycode triggering the edit */
|
|
40
99
|
keycode?: KeyCode;
|
|
41
|
-
/** Whether the edit
|
|
100
|
+
/** Whether the edit will happen in zen editor mode */
|
|
42
101
|
isZenEditor: boolean;
|
|
43
102
|
}
|
|
44
103
|
/**
|
|
45
|
-
* Event interface triggered when cell editing
|
|
46
|
-
* @interface ISheetEditEndedEventParams
|
|
47
|
-
* @augments {IEventBase}
|
|
104
|
+
* Event interface triggered when cell editing starts
|
|
48
105
|
*/
|
|
49
|
-
export interface
|
|
106
|
+
export interface ISheetEditStartedEventParams extends IEventBase {
|
|
50
107
|
/** The workbook instance */
|
|
51
108
|
workbook: FWorkbook;
|
|
52
109
|
/** The worksheet being edited */
|
|
53
110
|
worksheet: FWorksheet;
|
|
54
|
-
/** Row index of the
|
|
111
|
+
/** Row index of the editing cell */
|
|
55
112
|
row: number;
|
|
56
|
-
/** Column index of the
|
|
113
|
+
/** Column index of the editing cell */
|
|
57
114
|
column: number;
|
|
58
|
-
/** Type of input device event that triggered the edit
|
|
115
|
+
/** Type of input device event that triggered the edit */
|
|
59
116
|
eventType: DeviceInputEventType;
|
|
60
|
-
/** Optional keycode that triggered the edit
|
|
117
|
+
/** Optional keycode that triggered the edit */
|
|
61
118
|
keycode?: KeyCode;
|
|
62
|
-
/** Whether the edit
|
|
119
|
+
/** Whether the edit is happening in zen editor mode */
|
|
63
120
|
isZenEditor: boolean;
|
|
64
|
-
/** Whether the edit was confirmed or cancelled */
|
|
65
|
-
isConfirm: boolean;
|
|
66
121
|
}
|
|
67
122
|
/**
|
|
68
123
|
* Event interface triggered while cell content is being changed
|
|
69
|
-
* @interface ISheetEditChangingEventParams
|
|
70
|
-
* @augments {IEventBase}
|
|
71
124
|
*/
|
|
72
125
|
export interface ISheetEditChangingEventParams extends IEventBase {
|
|
73
126
|
/** The workbook instance */
|
|
@@ -84,72 +137,131 @@ export interface ISheetEditChangingEventParams extends IEventBase {
|
|
|
84
137
|
isZenEditor: boolean;
|
|
85
138
|
}
|
|
86
139
|
/**
|
|
87
|
-
* Event interface triggered before cell editing
|
|
88
|
-
* @interface IBeforeSheetEditStartEventParams
|
|
89
|
-
* @augments {IEventBase}
|
|
140
|
+
* Event interface triggered before cell editing ends
|
|
90
141
|
*/
|
|
91
|
-
export interface
|
|
142
|
+
export interface IBeforeSheetEditEndEventParams extends IEventBase {
|
|
92
143
|
/** The workbook instance */
|
|
93
144
|
workbook: FWorkbook;
|
|
94
|
-
/** The worksheet
|
|
145
|
+
/** The worksheet being edited */
|
|
95
146
|
worksheet: FWorksheet;
|
|
96
|
-
/** Row index of the cell
|
|
147
|
+
/** Row index of the editing cell */
|
|
97
148
|
row: number;
|
|
98
|
-
/** Column index of the cell
|
|
149
|
+
/** Column index of the editing cell */
|
|
99
150
|
column: number;
|
|
100
|
-
/**
|
|
151
|
+
/** Current value being edited */
|
|
152
|
+
value: RichTextValue;
|
|
153
|
+
/** Type of input device event triggering the edit end */
|
|
101
154
|
eventType: DeviceInputEventType;
|
|
102
|
-
/** Optional keycode triggering the edit */
|
|
155
|
+
/** Optional keycode triggering the edit end */
|
|
103
156
|
keycode?: KeyCode;
|
|
104
|
-
/** Whether the edit
|
|
157
|
+
/** Whether the edit is happening in zen editor mode */
|
|
105
158
|
isZenEditor: boolean;
|
|
159
|
+
/** Whether the edit will be confirmed or cancelled */
|
|
160
|
+
isConfirm: boolean;
|
|
106
161
|
}
|
|
107
162
|
/**
|
|
108
|
-
* Event interface triggered
|
|
109
|
-
* @interface IBeforeSheetEditEndEventParams
|
|
110
|
-
* @augments {IEventBase}
|
|
163
|
+
* Event interface triggered when cell editing ends
|
|
111
164
|
*/
|
|
112
|
-
export interface
|
|
165
|
+
export interface ISheetEditEndedEventParams extends IEventBase {
|
|
113
166
|
/** The workbook instance */
|
|
114
167
|
workbook: FWorkbook;
|
|
115
168
|
/** The worksheet being edited */
|
|
116
169
|
worksheet: FWorksheet;
|
|
117
|
-
/** Row index of the
|
|
170
|
+
/** Row index of the edited cell */
|
|
118
171
|
row: number;
|
|
119
|
-
/** Column index of the
|
|
172
|
+
/** Column index of the edited cell */
|
|
120
173
|
column: number;
|
|
121
|
-
/**
|
|
122
|
-
value: RichTextValue;
|
|
123
|
-
/** Type of input device event triggering the edit end */
|
|
174
|
+
/** Type of input device event that triggered the edit end */
|
|
124
175
|
eventType: DeviceInputEventType;
|
|
125
|
-
/** Optional keycode
|
|
176
|
+
/** Optional keycode that triggered the edit end */
|
|
126
177
|
keycode?: KeyCode;
|
|
127
|
-
/** Whether the edit
|
|
178
|
+
/** Whether the edit happened in zen editor mode */
|
|
128
179
|
isZenEditor: boolean;
|
|
129
|
-
/** Whether the edit
|
|
180
|
+
/** Whether the edit was confirmed or cancelled */
|
|
130
181
|
isConfirm: boolean;
|
|
131
182
|
}
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
183
|
+
/**
|
|
184
|
+
* @ignore
|
|
185
|
+
*/
|
|
186
|
+
export interface ISheetUIEventBase extends IEventBase {
|
|
187
|
+
/**
|
|
188
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
189
|
+
*/
|
|
190
|
+
workbook: FWorkbook;
|
|
191
|
+
/**
|
|
192
|
+
* The worksheet instance currently being operated on. {@link FWorksheet}
|
|
193
|
+
*/
|
|
194
|
+
worksheet: FWorksheet;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Event interface for cell-related events such as click, pointer down/up, hover, etc.
|
|
198
|
+
*/
|
|
199
|
+
export interface ICellEventParams extends ISheetUIEventBase {
|
|
200
|
+
row: number;
|
|
201
|
+
column: number;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Event interface for drag-related events such as drag over and drop on spreadsheet cells
|
|
205
|
+
*/
|
|
206
|
+
export interface IDragEventParams extends IDragCellPosition, ICellEventParams {
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Event interface for row header related events such as click, pointer down/up, hover, etc.
|
|
210
|
+
*/
|
|
211
|
+
export interface ISheetRowHeaderEventParams extends ISheetUIEventBase {
|
|
212
|
+
row: number;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Event interface for column header related events such as click, pointer down/up, hover, etc.
|
|
216
|
+
*/
|
|
217
|
+
export interface ISheetColumnHeaderEventParams extends ISheetUIEventBase {
|
|
218
|
+
column: number;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Event interface for scroll event on spreadsheet
|
|
222
|
+
*/
|
|
223
|
+
export interface IScrollEventParams extends ISheetUIEventBase {
|
|
224
|
+
scrollX: number;
|
|
225
|
+
scrollY: number;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Event interface for selection change and selection move events on spreadsheet
|
|
229
|
+
*/
|
|
230
|
+
export interface ISelectionEventParams extends ISheetUIEventBase {
|
|
231
|
+
selections: IRange[];
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* Event interface for sheet zoom change event
|
|
235
|
+
*/
|
|
236
|
+
export interface ISheetZoomEventParams extends IEventBase {
|
|
237
|
+
/**
|
|
238
|
+
* Zoom ratio
|
|
239
|
+
*/
|
|
240
|
+
zoom: number;
|
|
241
|
+
/**
|
|
242
|
+
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
243
|
+
*/
|
|
244
|
+
workbook: FWorkbook;
|
|
245
|
+
/**
|
|
246
|
+
* The worksheet instance currently being operated on. {@link FWorkbook}
|
|
247
|
+
*/
|
|
248
|
+
worksheet: FWorksheet;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* Event interface for sheet skeleton change event
|
|
252
|
+
*/
|
|
253
|
+
export interface ISheetSkeletonChangedEventParams extends ISheetUIEventBase {
|
|
254
|
+
skeleton: SpreadsheetSkeleton;
|
|
255
|
+
payload: CommandListenerSkeletonChange;
|
|
256
|
+
effectedRanges: FRange[];
|
|
257
|
+
}
|
|
146
258
|
/**
|
|
147
259
|
* @ignore
|
|
148
260
|
*/
|
|
149
261
|
export interface IFSheetsUIEventNameMixin {
|
|
150
262
|
/**
|
|
151
263
|
* Trigger this event before the clipboard content changes.
|
|
152
|
-
* Type of the event parameter is {@link
|
|
264
|
+
* Type of the event parameter is {@link IBeforeClipboardChangeEventParams}
|
|
153
265
|
* @example
|
|
154
266
|
* ```ts
|
|
155
267
|
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeClipboardChange, (params) => {
|
|
@@ -166,7 +278,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
166
278
|
readonly BeforeClipboardChange: 'BeforeClipboardChange';
|
|
167
279
|
/**
|
|
168
280
|
* Trigger this event after the clipboard content changes.
|
|
169
|
-
* Type of the event parameter is {@link
|
|
281
|
+
* Type of the event parameter is {@link IClipboardChangedEventParams}
|
|
170
282
|
* @example
|
|
171
283
|
* ```ts
|
|
172
284
|
* const disposable = univerAPI.addEvent(univerAPI.Event.ClipboardChanged, (params) => {
|
|
@@ -180,7 +292,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
180
292
|
readonly ClipboardChanged: 'ClipboardChanged';
|
|
181
293
|
/**
|
|
182
294
|
* Trigger this event before pasting.
|
|
183
|
-
* Type of the event parameter is {@link
|
|
295
|
+
* Type of the event parameter is {@link IBeforeClipboardPasteEventParams}
|
|
184
296
|
* @example
|
|
185
297
|
* ```ts
|
|
186
298
|
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeClipboardPaste, (params) => {
|
|
@@ -197,7 +309,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
197
309
|
readonly BeforeClipboardPaste: 'BeforeClipboardPaste';
|
|
198
310
|
/**
|
|
199
311
|
* Trigger this event after pasting.
|
|
200
|
-
* Type of the event parameter is {@link
|
|
312
|
+
* Type of the event parameter is {@link IClipboardPastedEventParams}
|
|
201
313
|
* @example
|
|
202
314
|
* ```ts
|
|
203
315
|
* const disposable = univerAPI.addEvent(univerAPI.Event.ClipboardPasted, (params) => {
|
|
@@ -287,7 +399,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
287
399
|
readonly SheetEditEnded: 'SheetEditEnded';
|
|
288
400
|
/**
|
|
289
401
|
* Event fired when a cell is clicked
|
|
290
|
-
* @see {@link
|
|
402
|
+
* @see {@link ICellEventParams}
|
|
291
403
|
* @example
|
|
292
404
|
* ```ts
|
|
293
405
|
* const disposable = univerAPI.addEvent(univerAPI.Event.CellClicked, (params) => {
|
|
@@ -301,7 +413,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
301
413
|
readonly CellClicked: 'CellClicked';
|
|
302
414
|
/**
|
|
303
415
|
* Event fired when a cell is pointer down
|
|
304
|
-
* @see {@link
|
|
416
|
+
* @see {@link ICellEventParams}
|
|
305
417
|
* @example
|
|
306
418
|
* ```ts
|
|
307
419
|
* const disposable = univerAPI.addEvent(univerAPI.Event.CellPointerDown, (params) => {
|
|
@@ -315,7 +427,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
315
427
|
readonly CellPointerDown: 'CellPointerDown';
|
|
316
428
|
/**
|
|
317
429
|
* Event fired when a cell is pointer up
|
|
318
|
-
* @see {@link
|
|
430
|
+
* @see {@link ICellEventParams}
|
|
319
431
|
* @example
|
|
320
432
|
* ```ts
|
|
321
433
|
* const disposable = univerAPI.addEvent(univerAPI.Event.CellPointerUp, (params) => {
|
|
@@ -329,7 +441,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
329
441
|
readonly CellPointerUp: 'CellPointerUp';
|
|
330
442
|
/**
|
|
331
443
|
* Event fired when a cell is hovered
|
|
332
|
-
* @see {@link
|
|
444
|
+
* @see {@link ICellEventParams}
|
|
333
445
|
* @example
|
|
334
446
|
* ```ts
|
|
335
447
|
* const disposable = univerAPI.addEvent(univerAPI.Event.CellHover, (params) => {
|
|
@@ -343,7 +455,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
343
455
|
readonly CellHover: 'CellHover';
|
|
344
456
|
/**
|
|
345
457
|
* Event fired when move on spreadsheet cells
|
|
346
|
-
* @see {@link
|
|
458
|
+
* @see {@link ICellEventParams}
|
|
347
459
|
* @example
|
|
348
460
|
* ```ts
|
|
349
461
|
* const disposable = univerAPI.addEvent(univerAPI.Event.CellPointerMove, (params) => {
|
|
@@ -357,7 +469,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
357
469
|
readonly CellPointerMove: 'CellPointerMove';
|
|
358
470
|
/**
|
|
359
471
|
* Triggered when a row header is clicked
|
|
360
|
-
* @see {@link
|
|
472
|
+
* @see {@link ISheetRowHeaderEventParams}
|
|
361
473
|
* @example
|
|
362
474
|
* ```typescript
|
|
363
475
|
* const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderClick, (params) => {
|
|
@@ -371,7 +483,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
371
483
|
readonly RowHeaderClick: 'RowHeaderClick';
|
|
372
484
|
/**
|
|
373
485
|
* Triggered when pointer is pressed down on a row header
|
|
374
|
-
* @see {@link
|
|
486
|
+
* @see {@link ISheetRowHeaderEventParams}
|
|
375
487
|
* @example
|
|
376
488
|
* ```typescript
|
|
377
489
|
* const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderPointerDown, (params) => {
|
|
@@ -385,7 +497,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
385
497
|
readonly RowHeaderPointerDown: 'RowHeaderPointerDown';
|
|
386
498
|
/**
|
|
387
499
|
* Triggered when pointer is released on a row header
|
|
388
|
-
* @see {@link
|
|
500
|
+
* @see {@link ISheetRowHeaderEventParams}
|
|
389
501
|
* @example
|
|
390
502
|
* ```typescript
|
|
391
503
|
* const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderPointerUp, (params) => {
|
|
@@ -399,7 +511,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
399
511
|
readonly RowHeaderPointerUp: 'RowHeaderPointerUp';
|
|
400
512
|
/**
|
|
401
513
|
* Triggered when pointer hovers over a row header
|
|
402
|
-
* @see {@link
|
|
514
|
+
* @see {@link ISheetRowHeaderEventParams}
|
|
403
515
|
* @example
|
|
404
516
|
* ```typescript
|
|
405
517
|
* const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderHover, (params) => {
|
|
@@ -413,7 +525,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
413
525
|
readonly RowHeaderHover: 'RowHeaderHover';
|
|
414
526
|
/**
|
|
415
527
|
* Triggered when a column header is clicked
|
|
416
|
-
* @see {@link
|
|
528
|
+
* @see {@link ISheetColumnHeaderEventParams}
|
|
417
529
|
* @example
|
|
418
530
|
* ```typescript
|
|
419
531
|
* const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderClick, (params) => {
|
|
@@ -427,7 +539,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
427
539
|
readonly ColumnHeaderClick: 'ColumnHeaderClick';
|
|
428
540
|
/**
|
|
429
541
|
* Triggered when pointer is pressed down on a column header
|
|
430
|
-
* @see {@link
|
|
542
|
+
* @see {@link ISheetColumnHeaderEventParams}
|
|
431
543
|
* @example
|
|
432
544
|
* ```typescript
|
|
433
545
|
* const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderPointerDown, (params) => {
|
|
@@ -441,7 +553,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
441
553
|
readonly ColumnHeaderPointerDown: 'ColumnHeaderPointerDown';
|
|
442
554
|
/**
|
|
443
555
|
* Triggered when pointer is released on a column header
|
|
444
|
-
* @see {@link
|
|
556
|
+
* @see {@link ISheetColumnHeaderEventParams}
|
|
445
557
|
* @example
|
|
446
558
|
* ```typescript
|
|
447
559
|
* const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderPointerUp, (params) => {
|
|
@@ -455,7 +567,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
455
567
|
readonly ColumnHeaderPointerUp: 'ColumnHeaderPointerUp';
|
|
456
568
|
/**
|
|
457
569
|
* Triggered when pointer hovers over a column header
|
|
458
|
-
* @see {@link
|
|
570
|
+
* @see {@link ISheetColumnHeaderEventParams}
|
|
459
571
|
* @example
|
|
460
572
|
* ```typescript
|
|
461
573
|
* const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderHover, (params) => {
|
|
@@ -469,7 +581,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
469
581
|
readonly ColumnHeaderHover: 'ColumnHeaderHover';
|
|
470
582
|
/**
|
|
471
583
|
* Event fired when the drag element passes over the spreadsheet cells
|
|
472
|
-
* @see {@link
|
|
584
|
+
* @see {@link IDragEventParams}
|
|
473
585
|
* @example
|
|
474
586
|
* ```ts
|
|
475
587
|
* const disposable = univerAPI.addEvent(univerAPI.Event.DragOver, (params) => {
|
|
@@ -483,7 +595,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
483
595
|
readonly DragOver: 'DragOver';
|
|
484
596
|
/**
|
|
485
597
|
* Event fired when the drag element is dropped on the spreadsheet cells
|
|
486
|
-
* @see {@link
|
|
598
|
+
* @see {@link IDragEventParams}
|
|
487
599
|
* @example
|
|
488
600
|
* ```ts
|
|
489
601
|
* const disposable = univerAPI.addEvent(univerAPI.Event.Drop, (params) => {
|
|
@@ -497,7 +609,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
497
609
|
readonly Drop: 'Drop';
|
|
498
610
|
/**
|
|
499
611
|
* Event fired when scroll spreadsheet.
|
|
500
|
-
* @see {@link
|
|
612
|
+
* @see {@link IScrollEventParams}
|
|
501
613
|
* @example
|
|
502
614
|
* ```ts
|
|
503
615
|
* const disposable = univerAPI.addEvent(univerAPI.Event.Scroll, (params) => {
|
|
@@ -511,7 +623,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
511
623
|
readonly Scroll: 'Scroll';
|
|
512
624
|
/**
|
|
513
625
|
* Event fired when selection changed.
|
|
514
|
-
* @see {@link
|
|
626
|
+
* @see {@link ISelectionEventParams}
|
|
515
627
|
* @example
|
|
516
628
|
* ```ts
|
|
517
629
|
* const disposable = univerAPI.addEvent(univerAPI.Event.SelectionChanged, (params)=> {
|
|
@@ -525,7 +637,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
525
637
|
readonly SelectionChanged: 'SelectionChanged';
|
|
526
638
|
/**
|
|
527
639
|
* Event fired when selection move start
|
|
528
|
-
* @see {@link
|
|
640
|
+
* @see {@link ISelectionEventParams}
|
|
529
641
|
* @example
|
|
530
642
|
* ```ts
|
|
531
643
|
* const disposable = univerAPI.addEvent(univerAPI.Event.SelectionMoveStart, (params)=> {
|
|
@@ -539,7 +651,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
539
651
|
readonly SelectionMoveStart: 'SelectionMoveStart';
|
|
540
652
|
/**
|
|
541
653
|
* Event fired when selection move end
|
|
542
|
-
* @see {@link
|
|
654
|
+
* @see {@link ISelectionEventParams}
|
|
543
655
|
* @example
|
|
544
656
|
* ```ts
|
|
545
657
|
* const disposable = univerAPI.addEvent(univerAPI.Event.SelectionMoving, (params)=> {
|
|
@@ -553,7 +665,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
553
665
|
readonly SelectionMoving: 'SelectionMoving';
|
|
554
666
|
/**
|
|
555
667
|
* Event fired when selection move end
|
|
556
|
-
* @see {@link
|
|
668
|
+
* @see {@link ISelectionEventParams}
|
|
557
669
|
* @example
|
|
558
670
|
* ```ts
|
|
559
671
|
* const disposable = univerAPI.addEvent(univerAPI.Event.SelectionMoveEnd, (params)=> {
|
|
@@ -567,7 +679,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
567
679
|
readonly SelectionMoveEnd: 'SelectionMoveEnd';
|
|
568
680
|
/**
|
|
569
681
|
* Event fired when zoom changed
|
|
570
|
-
* @see {@link
|
|
682
|
+
* @see {@link ISheetZoomEventParams}
|
|
571
683
|
* @example
|
|
572
684
|
* ```ts
|
|
573
685
|
* const disposable = univerAPI.addEvent(univerAPI.Event.SheetZoomChanged, (params)=> {
|
|
@@ -581,7 +693,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
581
693
|
readonly SheetZoomChanged: 'SheetZoomChanged';
|
|
582
694
|
/**
|
|
583
695
|
* Event fired before zoom changed
|
|
584
|
-
* @see {@link
|
|
696
|
+
* @see {@link ISheetZoomEventParams}
|
|
585
697
|
* @example
|
|
586
698
|
* ```ts
|
|
587
699
|
* const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetZoomChange, (params)=> {
|
|
@@ -598,7 +710,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
598
710
|
readonly BeforeSheetZoomChange: 'BeforeSheetZoomChange';
|
|
599
711
|
/**
|
|
600
712
|
* Event fired when sheet skeleton changed
|
|
601
|
-
* @see {@link
|
|
713
|
+
* @see {@link ISheetSkeletonChangedEventParams}
|
|
602
714
|
* @example
|
|
603
715
|
* ```ts
|
|
604
716
|
* const disposable = univerAPI.addEvent(univerAPI.Event.SheetSkeletonChanged, (params)=> {
|
|
@@ -611,7 +723,7 @@ export interface IFSheetsUIEventNameMixin {
|
|
|
611
723
|
*/
|
|
612
724
|
readonly SheetSkeletonChanged: 'SheetSkeletonChanged';
|
|
613
725
|
}
|
|
614
|
-
export declare class
|
|
726
|
+
export declare class FSheetsUIEventNameMixin extends FEventName implements IFSheetsUIEventNameMixin {
|
|
615
727
|
get BeforeClipboardChange(): 'BeforeClipboardChange';
|
|
616
728
|
get ClipboardChanged(): 'ClipboardChanged';
|
|
617
729
|
get BeforeClipboardPaste(): 'BeforeClipboardPaste';
|
|
@@ -648,140 +760,43 @@ export declare class FSheetsUIEventName implements IFSheetsUIEventNameMixin {
|
|
|
648
760
|
/**
|
|
649
761
|
* @ignore
|
|
650
762
|
*/
|
|
651
|
-
export interface
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
/**
|
|
657
|
-
* The worksheet instance currently being operated on. {@link FWorksheet}
|
|
658
|
-
*/
|
|
659
|
-
worksheet: FWorksheet;
|
|
660
|
-
}
|
|
661
|
-
export interface IBeforeClipboardChangeParam extends IEventBase {
|
|
662
|
-
/**
|
|
663
|
-
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
664
|
-
*/
|
|
665
|
-
workbook: FWorkbook;
|
|
666
|
-
/**
|
|
667
|
-
* The worksheet instance currently being operated on. {@link FWorksheet}
|
|
668
|
-
*/
|
|
669
|
-
worksheet: FWorksheet;
|
|
670
|
-
/**
|
|
671
|
-
* Clipboard Text String
|
|
672
|
-
*/
|
|
673
|
-
text: string;
|
|
674
|
-
/**
|
|
675
|
-
* Clipboard HTML String
|
|
676
|
-
*/
|
|
677
|
-
html: string;
|
|
678
|
-
/**
|
|
679
|
-
* The sheet containing the content that was (copied/cut)
|
|
680
|
-
*/
|
|
681
|
-
fromSheet: FWorksheet;
|
|
682
|
-
/**
|
|
683
|
-
* The range containing the content that was (copied/cut)
|
|
684
|
-
*/
|
|
685
|
-
fromRange: FRange;
|
|
686
|
-
}
|
|
687
|
-
export type IClipboardChangedParam = IBeforeClipboardChangeParam;
|
|
688
|
-
export interface IBeforeClipboardPasteParam extends IEventBase {
|
|
689
|
-
/**
|
|
690
|
-
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
691
|
-
*/
|
|
692
|
-
workbook: FWorkbook;
|
|
693
|
-
/**
|
|
694
|
-
* The worksheet instance currently being operated on. {@link FWorkbook}
|
|
695
|
-
*/
|
|
696
|
-
worksheet: FWorksheet;
|
|
697
|
-
/**
|
|
698
|
-
* Clipboard Text String
|
|
699
|
-
*/
|
|
700
|
-
text?: string;
|
|
701
|
-
/**
|
|
702
|
-
* Clipboard HTML String
|
|
703
|
-
*/
|
|
704
|
-
html?: string;
|
|
705
|
-
}
|
|
706
|
-
export type IClipboardPastedParam = IBeforeClipboardPasteParam;
|
|
707
|
-
export interface ISheetZoomEvent extends IEventBase {
|
|
708
|
-
/**
|
|
709
|
-
* Zoom ratio
|
|
710
|
-
*/
|
|
711
|
-
zoom: number;
|
|
712
|
-
/**
|
|
713
|
-
* The workbook instance currently being operated on. {@link FWorkbook}
|
|
714
|
-
*/
|
|
715
|
-
workbook: FWorkbook;
|
|
716
|
-
/**
|
|
717
|
-
* The worksheet instance currently being operated on. {@link FWorkbook}
|
|
718
|
-
*/
|
|
719
|
-
worksheet: FWorksheet;
|
|
720
|
-
}
|
|
721
|
-
export interface ICellEventParam extends ISheetUIEventBase {
|
|
722
|
-
row: number;
|
|
723
|
-
column: number;
|
|
724
|
-
}
|
|
725
|
-
export interface IDragEventParam extends IDragCellPosition, ICellEventParam {
|
|
726
|
-
}
|
|
727
|
-
export interface IScrollEventParam extends ISheetUIEventBase {
|
|
728
|
-
scrollX: number;
|
|
729
|
-
scrollY: number;
|
|
730
|
-
}
|
|
731
|
-
export interface ISelectionEventParam extends ISheetUIEventBase {
|
|
732
|
-
selections: IRange[];
|
|
733
|
-
}
|
|
734
|
-
export interface ISheetRowHeaderEvent extends ISheetUIEventBase {
|
|
735
|
-
row: number;
|
|
736
|
-
}
|
|
737
|
-
export interface ISheetColumnHeaderEvent extends ISheetUIEventBase {
|
|
738
|
-
column: number;
|
|
739
|
-
}
|
|
740
|
-
export interface ISheetSkeletonChangedEvent extends ISheetUIEventBase {
|
|
741
|
-
skeleton: SpreadsheetSkeleton;
|
|
742
|
-
payload: CommandListenerSkeletonChange;
|
|
743
|
-
effectedRanges: FRange[];
|
|
744
|
-
}
|
|
745
|
-
/**
|
|
746
|
-
* @ignore
|
|
747
|
-
*/
|
|
748
|
-
export interface IFSheetsUIEventParamConfig {
|
|
749
|
-
BeforeClipboardChange: IBeforeClipboardChangeParam;
|
|
750
|
-
ClipboardChanged: IClipboardChangedParam;
|
|
751
|
-
BeforeClipboardPaste: IBeforeClipboardPasteParam;
|
|
752
|
-
ClipboardPasted: IClipboardPastedParam;
|
|
763
|
+
export interface ISheetsUIEventParamConfig {
|
|
764
|
+
BeforeClipboardChange: IBeforeClipboardChangeEventParams;
|
|
765
|
+
ClipboardChanged: IClipboardChangedEventParams;
|
|
766
|
+
BeforeClipboardPaste: IBeforeClipboardPasteEventParams;
|
|
767
|
+
ClipboardPasted: IClipboardPastedEventParams;
|
|
753
768
|
BeforeSheetEditStart: IBeforeSheetEditStartEventParams;
|
|
754
769
|
SheetEditStarted: ISheetEditStartedEventParams;
|
|
755
770
|
SheetEditChanging: ISheetEditChangingEventParams;
|
|
756
771
|
BeforeSheetEditEnd: IBeforeSheetEditEndEventParams;
|
|
757
772
|
SheetEditEnded: ISheetEditEndedEventParams;
|
|
758
|
-
CellClicked:
|
|
759
|
-
CellHover:
|
|
760
|
-
CellPointerDown:
|
|
761
|
-
CellPointerUp:
|
|
762
|
-
CellPointerMove:
|
|
763
|
-
Drop:
|
|
764
|
-
DragOver:
|
|
765
|
-
RowHeaderClick:
|
|
766
|
-
RowHeaderHover:
|
|
767
|
-
RowHeaderPointerDown:
|
|
768
|
-
RowHeaderPointerUp:
|
|
769
|
-
ColumnHeaderClick:
|
|
770
|
-
ColumnHeaderHover:
|
|
771
|
-
ColumnHeaderPointerDown:
|
|
772
|
-
ColumnHeaderPointerUp:
|
|
773
|
-
Scroll:
|
|
774
|
-
SelectionMoveStart:
|
|
775
|
-
SelectionMoving:
|
|
776
|
-
SelectionMoveEnd:
|
|
777
|
-
SelectionChanged:
|
|
778
|
-
SheetZoomChanged:
|
|
779
|
-
BeforeSheetZoomChange:
|
|
780
|
-
SheetSkeletonChanged:
|
|
773
|
+
CellClicked: ICellEventParams;
|
|
774
|
+
CellHover: ICellEventParams;
|
|
775
|
+
CellPointerDown: ICellEventParams;
|
|
776
|
+
CellPointerUp: ICellEventParams;
|
|
777
|
+
CellPointerMove: ICellEventParams;
|
|
778
|
+
Drop: IDragEventParams;
|
|
779
|
+
DragOver: IDragEventParams;
|
|
780
|
+
RowHeaderClick: ISheetRowHeaderEventParams;
|
|
781
|
+
RowHeaderHover: ISheetRowHeaderEventParams;
|
|
782
|
+
RowHeaderPointerDown: ISheetRowHeaderEventParams;
|
|
783
|
+
RowHeaderPointerUp: ISheetRowHeaderEventParams;
|
|
784
|
+
ColumnHeaderClick: ISheetColumnHeaderEventParams;
|
|
785
|
+
ColumnHeaderHover: ISheetColumnHeaderEventParams;
|
|
786
|
+
ColumnHeaderPointerDown: ISheetColumnHeaderEventParams;
|
|
787
|
+
ColumnHeaderPointerUp: ISheetColumnHeaderEventParams;
|
|
788
|
+
Scroll: IScrollEventParams;
|
|
789
|
+
SelectionMoveStart: ISelectionEventParams;
|
|
790
|
+
SelectionMoving: ISelectionEventParams;
|
|
791
|
+
SelectionMoveEnd: ISelectionEventParams;
|
|
792
|
+
SelectionChanged: ISelectionEventParams;
|
|
793
|
+
SheetZoomChanged: ISheetZoomEventParams;
|
|
794
|
+
BeforeSheetZoomChange: ISheetZoomEventParams;
|
|
795
|
+
SheetSkeletonChanged: ISheetSkeletonChangedEventParams;
|
|
781
796
|
}
|
|
782
797
|
declare module '@univerjs/core/facade' {
|
|
783
798
|
interface FEventName extends IFSheetsUIEventNameMixin {
|
|
784
799
|
}
|
|
785
|
-
interface IEventParamConfig extends
|
|
800
|
+
interface IEventParamConfig extends ISheetsUIEventParamConfig {
|
|
786
801
|
}
|
|
787
802
|
}
|