sheetnext 0.2.10 → 0.2.12

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.
@@ -1,341 +1,341 @@
1
- # Event API
2
-
3
- > Generated: 2026-04-28
4
-
5
- ## Subscription surface
6
-
7
- Use `SN.Event` for registration and dispatch. `SN.Event` is an `EventEmitter` instance exposed on the root workbook object.
8
-
9
- ```js
10
- SN.Event.on('beforeCellEdit', (e) => {
11
- if (e.data.cell?.locked) e.cancel('Cell is locked')
12
- })
13
-
14
- SN.Event.once('afterSheetAdd', (e) => {
15
- console.log(e.data.sheet)
16
- })
17
- ```
18
-
19
- ## EventEmitter
20
- - Event Transmitter
21
-
22
- ### Methods
23
- #### `on(event, handler, options = {}): EventEmitter`
24
- - Register Event Listener
25
-
26
- **Parameters**
27
- | Name | Type | Required | Default | Description |
28
- | --- | --- | --- | --- | --- |
29
- | event | string | Yes | - | Event Name |
30
- | handler | Function | Yes | - | Handling function |
31
- | options | Object | No | {} | Options |
32
- | options.id | string | Yes | - | Unique identity (anti duplicate binding) |
33
- | options.priority | number | Yes | - | Priority (execute as soon as possible) |
34
- | options.once | boolean | Yes | - | Whether to execute only once |
35
-
36
- **Returns**
37
- - Type: `EventEmitter`
38
- - Chain Calls Supported
39
-
40
- #### `once(event, handler, options = {}): EventEmitter`
41
- - Sign up for a one-time event listener
42
-
43
- **Parameters**
44
- | Name | Type | Required | Default | Description |
45
- | --- | --- | --- | --- | --- |
46
- | event | string | Yes | - | Event Name |
47
- | handler | Function | Yes | - | Handling function |
48
- | options | Object | No | {} | Options |
49
-
50
- **Returns**
51
- - Type: `EventEmitter`
52
-
53
- #### `off(event, idOrHandler): EventEmitter`
54
- - Remove Event Listener
55
-
56
- **Parameters**
57
- | Name | Type | Required | Default | Description |
58
- | --- | --- | --- | --- | --- |
59
- | event | string | Yes | - | Event Name |
60
- | idOrHandler | string \| Function | Yes | - | id or handler reference |
61
-
62
- **Returns**
63
- - Type: `EventEmitter`
64
-
65
- #### `offAll(): EventEmitter`
66
- - Remove all event listeners
67
-
68
- **Returns**
69
- - Type: `EventEmitter`
70
-
71
- #### `emit(event, data = {}): SheetEvent`
72
- - Trigger event
73
-
74
- **Parameters**
75
- | Name | Type | Required | Default | Description |
76
- | --- | --- | --- | --- | --- |
77
- | event | string | Yes | - | Event Name |
78
- | data | Object | No | {} | Event Data |
79
-
80
- **Returns**
81
- - Type: `SheetEvent`
82
- - Event object (canceled status can be checked)
83
-
84
- #### `async emitAsync(event, data = {}): Promise<SheetEvent>`
85
- - Trigger event with async hooks support.
86
-
87
- **Parameters**
88
- | Name | Type | Required | Default | Description |
89
- | --- | --- | --- | --- | --- |
90
- | event | string | Yes | - | event name |
91
- | data | Object | No | {} | event data |
92
-
93
- **Returns**
94
- - Type: `Promise<SheetEvent>`
95
-
96
- #### `hasListeners(event): boolean`
97
- - Check for listeners
98
-
99
- **Parameters**
100
- | Name | Type | Required | Default | Description |
101
- | --- | --- | --- | --- | --- |
102
- | event | string | Yes | - | Event Name |
103
-
104
- **Returns**
105
- - Type: `boolean`
106
-
107
- #### `listenerCount(event): number`
108
- - Get the number of listeners
109
-
110
- **Parameters**
111
- | Name | Type | Required | Default | Description |
112
- | --- | --- | --- | --- | --- |
113
- | event | string | Yes | - | Event name (optional, return total if not passed) |
114
-
115
- **Returns**
116
- - Type: `number`
117
-
118
- #### `listEvents(): Array<{event: string, count: number}>`
119
- - Get all event names and number of monitors
120
-
121
- **Returns**
122
- - Type: `Array<{event: string, count: number}>`
123
-
124
- ## SheetEvent
125
- - Event object
126
-
127
- ### Props
128
- | Name | Type | Static | Default | Description |
129
- | --- | --- | --- | --- | --- |
130
- | type | string | No | type | - |
131
- | data | Object | No | data | - |
132
- | target | Object | No | target | - |
133
- | canceled | boolean | No | false | - |
134
- | stopped | boolean | No | false | - |
135
- | cancelReason | null | No | null | - |
136
- | timestamp | number | No | Date.now() | - |
137
-
138
- ### Methods
139
- #### `cancel(reason = '')`
140
- - Cancel event (block default behavior)
141
-
142
- **Parameters**
143
- | Name | Type | Required | Default | Description |
144
- | --- | --- | --- | --- | --- |
145
- | reason | string | No | '' | Reason for canceling (optional, used as a reminder) |
146
-
147
- #### `stopPropagation()`
148
- - Stop event propagation (no longer performing follow-up listener)
149
-
150
- #### `waitUntil(promise)`
151
- - Register async work for emitAsync to await.
152
-
153
- **Parameters**
154
- | Name | Type | Required | Default | Description |
155
- | --- | --- | --- | --- | --- |
156
- | promise | Promise | Yes | - | - |
157
-
158
- ## Emitted events
159
-
160
- - Total detected events: 120
161
- - Dynamic event patterns: 7
162
-
163
- ### Col
164
- | Event | Mode | Cancelable | Payload Keys |
165
- | --- | --- | --- | --- |
166
- | after${eventBase} | emit | No | col, newHidden, oldHidden, row, sheet |
167
- | afterColResize | emit | No | col, newWidth, oldWidth, sheet |
168
- | before${eventBase} | emit | No | col, newHidden, oldHidden, row, sheet |
169
- | beforeColResize | emit | No | col, newWidth, oldWidth, sheet |
170
-
171
- ### Sheet
172
- | Event | Mode | Cancelable | Payload Keys |
173
- | --- | --- | --- | --- |
174
- | after${eventSuffix} | emit | No | [indexKey], changedCount, limitedCount, maxLevel, sheet |
175
- | afterClearCellControl | emit | No | ...summary, sheet |
176
- | afterClearDataValidation | emit | No | ...summary, sheet |
177
- | afterConsolidate | emit | No | ...summary, sheet |
178
- | afterDeleteColumns | emit | No | col, count, sheet |
179
- | afterDeleteRows | emit | No | count, row, sheet |
180
- | afterFlashFill | emit | No | exampleCount, filledCount, sheet, sourceRange, strategy, targetRange |
181
- | afterInsertColumns | emit | No | col, count, sheet |
182
- | afterInsertRows | emit | No | count, row, sheet |
183
- | afterMerge | emit | No | areas, mode, sheet |
184
- | afterMoveArea | emit | No | moveArea, sheet, targetArea |
185
- | afterSelectionChange | emit | No | newAreas, newCell, oldAreas, oldCell, sheet, type |
186
- | afterSetCellControl | emit | No | ...summary, control, sheet |
187
- | afterSetDataValidation | emit | No | ...summary, sheet |
188
- | afterSheetRename | emit | No | newName, oldName, sheet |
189
- | afterSort | emit | No | options, range, sheet, sortKeys, success |
190
- | afterSubtotal | emit | No | ...summary, options, sheet |
191
- | afterTextToColumns | emit | No | columnCount, rowCount, sheet, sourceRange, targetRange |
192
- | afterUnmerge | emit | No | cellAd, sheet |
193
- | before${eventSuffix} | emit | No | [indexKey], areas, maxLevel, sheet |
194
- | beforeClearCellControl | emit | No | areas, sheet |
195
- | beforeClearDataValidation | emit | No | areas, sheet |
196
- | beforeConsolidate | emit | No | functionName, sheet, skipBlanks, sourceRanges, targetRange |
197
- | beforeDeleteColumns | emit | No | col, count, sheet |
198
- | beforeDeleteRows | emit | No | count, row, sheet |
199
- | beforeFlashFill | emit | No | exampleCount, sheet, sourceRange, strategy, targetRange |
200
- | beforeInsertColumns | emit | No | col, count, sheet |
201
- | beforeInsertRows | emit | No | count, row, sheet |
202
- | beforeMerge | emit | No | areas, mode, sheet |
203
- | beforeMoveArea | emit | No | moveArea, sheet, targetArea |
204
- | beforeSelectionChange | emit | No | newAreas, newCell, oldAreas, oldCell, sheet, type |
205
- | beforeSetCellControl | emit | No | areas, control, sheet |
206
- | beforeSetDataValidation | emit | No | areas, rule, sheet |
207
- | beforeSheetRename | emit | No | newName, oldName, sheet |
208
- | beforeSort | emit | No | options, range, sheet, sortKeys |
209
- | beforeSubtotal | emit | No | options, range, sheet |
210
- | beforeTextToColumns | emit | No | options, sheet, sourceRange, targetRange |
211
- | beforeUnmerge | emit | No | cellAd, sheet |
212
-
213
- ### Workbook
214
- | Event | Mode | Cancelable | Payload Keys |
215
- | --- | --- | --- | --- |
216
- | afterActiveSheetChange | emit | No | newSheet, oldSheet |
217
- | afterOperation | emitAsync | No | - |
218
- | afterOperation:${op.type} | emitAsync | No | - |
219
- | afterSheetAdd | emit | No | name, sheet |
220
- | afterSheetDelete | emit | No | index, name, sheet |
221
- | afterSheetMove | emit | No | fromIndex, sheet, toIndex |
222
- | afterWorkbookRename | emit | No | newName, oldName |
223
- | beforeActiveSheetChange | emit | No | newSheet, oldSheet |
224
- | beforeOperation | emit | No | ...data, operation |
225
- | beforeOperation:${type} | emit | No | ...data, operation |
226
- | beforeSheetAdd | emit | No | name |
227
- | beforeSheetDelete | emit | No | index, name, sheet |
228
- | beforeSheetMove | emit | No | fromIndex, sheet, toIndex |
229
- | beforeWorkbookRename | emit | No | newName, oldName |
230
-
231
- ### AI
232
- | Event | Mode | Cancelable | Payload Keys |
233
- | --- | --- | --- | --- |
234
- | afterAIRequest | emitAsync | No | durationMs, request, response, result, status, textBlock, ui |
235
- | aiRequestChunk | emit | No | chunk, chunkIndex, request, textBlock, ui |
236
- | aiRequestError | emitAsync | No | durationMs, error, request, response, status, textBlock, ui |
237
- | aiRequestFinally | emitAsync | No | durationMs, error, request, response, result, status, textBlock, ui |
238
- | aiRequestStart | emit | No | request, textBlock, ui |
239
- | beforeAIRequest | emitAsync | No | request, textBlock, ui |
240
-
241
- ### AutoFilter
242
- | Event | Mode | Cancelable | Payload Keys |
243
- | --- | --- | --- | --- |
244
- | afterAutoFilterApply | emit | No | ...eventBase, allHiddenRowsAdded, allHiddenRowsRemoved, hiddenRowsAdded, hiddenRowsRemoved, range, sheet |
245
- | afterAutoFilterClear | emit | No | ...eventBase, range, ref, sheet |
246
- | afterAutoFilterClearAllFilters | emit | No | ...eventBase, sheet |
247
- | afterAutoFilterClearColumnFilter | emit | No | ...eventBase, colIndex, prevFilter, sheet |
248
- | afterAutoFilterSetColumnFilter | emit | No | ...eventBase, colIndex, filter, prevFilter, sheet |
249
- | afterAutoFilterSetRange | emit | No | ...eventBase, range, sheet |
250
- | beforeAutoFilter | emit | No | ...eventBase, action, colIndex, filter, range, sheet |
251
- | beforeAutoFilterApply | emit | No | ...eventBase, columns, range, sheet |
252
- | beforeAutoFilterClear | emit | No | ...eventBase, range, ref, sheet |
253
- | beforeAutoFilterClearAllFilters | emit | No | ...eventBase, filters, sheet |
254
- | beforeAutoFilterClearColumnFilter | emit | No | ...eventBase, colIndex, prevFilter, sheet |
255
- | beforeAutoFilterSetColumnFilter | emit | No | ...eventBase, colIndex, filter, prevFilter, sheet |
256
- | beforeAutoFilterSetRange | emit | No | ...eventBase, range, sheet |
257
-
258
- ### Cell
259
- | Event | Mode | Cancelable | Payload Keys |
260
- | --- | --- | --- | --- |
261
- | afterCellEdit | emit | No | cell, col, newValue, oldValue, row, sheet |
262
- | afterCellStyleChange | emit | No | cell, col, newStyle, oldStyle, row, sheet |
263
- | afterHyperlinkInsert | emit | No | cell, col, hyperlink, row, sheet |
264
- | beforeCellEdit | emit | No | cell, col, newValue, oldValue, row, sheet |
265
- | beforeCellStyleChange | emit | No | cell, col, newStyle, oldStyle, row, sheet |
266
- | beforeHyperlinkInsert | emit | No | cell, col, hyperlink, row, sheet |
267
-
268
- ### Drawing
269
- | Event | Mode | Cancelable | Payload Keys |
270
- | --- | --- | --- | --- |
271
- | afterDrawingAdd | emit | No | config, drawing, sheet |
272
- | afterDrawingRemove | emit | No | drawing, id, sheet |
273
- | beforeDrawingAdd | emit | No | config, sheet |
274
- | beforeDrawingRemove | emit | No | drawing, id, sheet |
275
-
276
- ### PivotTable
277
- | Event | Mode | Cancelable | Payload Keys |
278
- | --- | --- | --- | --- |
279
- | afterPivotTableAdd | emit | No | config, pivotTable, sheet |
280
- | afterPivotTableChange | emit | No | action, pivotTable, sheet, sourceRangeRef, sourceSheet |
281
- | beforePivotTableAdd | emit | No | config, sheet |
282
- | beforePivotTableChange | emit | No | action, pivotTable, sheet, sourceRangeRef, sourceSheet |
283
-
284
- ### UndoRedo
285
- | Event | Mode | Cancelable | Payload Keys |
286
- | --- | --- | --- | --- |
287
- | afterRedo | emit | No | tx |
288
- | afterUndo | emit | No | tx |
289
- | beforeRedo | emit | No | tx |
290
- | beforeUndo | emit | No | tx |
291
-
292
- ### Row
293
- | Event | Mode | Cancelable | Payload Keys |
294
- | --- | --- | --- | --- |
295
- | afterRowResize | emit | No | newHeight, oldHeight, row, sheet |
296
- | beforeRowResize | emit | No | newHeight, oldHeight, row, sheet |
297
-
298
- ### Slicer
299
- | Event | Mode | Cancelable | Payload Keys |
300
- | --- | --- | --- | --- |
301
- | afterSlicerAdd | emit | No | config, sheet, slicer |
302
- | afterSlicerRemove | emit | No | id, sheet, slicer |
303
- | beforeSlicerAdd | emit | No | config, sheet |
304
- | beforeSlicerRemove | emit | No | id, sheet, slicer |
305
-
306
- ### Sparkline
307
- | Event | Mode | Cancelable | Payload Keys |
308
- | --- | --- | --- | --- |
309
- | afterSparklineAdd | emit | No | config, sheet, sparkline |
310
- | afterSparklineRemove | emit | No | c, r, sheet, sparkline |
311
- | beforeSparklineAdd | emit | No | config, sheet |
312
- | beforeSparklineRemove | emit | No | c, r, sheet, sparkline |
313
-
314
- ### Table
315
- | Event | Mode | Cancelable | Payload Keys |
316
- | --- | --- | --- | --- |
317
- | afterTableAdd | emit | No | options, sheet, table |
318
- | afterTableAutoFilterToggle | emit | No | newValue, oldValue, sheet, table |
319
- | afterTableRemove | emit | No | id, sheet, table |
320
- | afterTableRename | emit | No | newName, oldName, sheet, table |
321
- | afterTableResize | emit | No | newRef, oldRef, sheet, table |
322
- | afterTableStyleChange | emit | No | newStyle, oldStyle, sheet, table |
323
- | afterTableTotalsRowToggle | emit | No | newValue, oldValue, sheet, table |
324
- | beforeTableAdd | emit | No | options, sheet |
325
- | beforeTableAutoFilterToggle | emit | No | newValue, oldValue, sheet, table |
326
- | beforeTableRemove | emit | No | id, sheet, table |
327
- | beforeTableRename | emit | No | newName, oldName, sheet, table |
328
- | beforeTableResize | emit | No | newRef, oldRef, sheet, table |
329
- | beforeTableStyleChange | emit | No | newStyle, oldStyle, sheet, table |
330
- | beforeTableTotalsRowToggle | emit | No | newValue, oldValue, sheet, table |
331
-
332
- ### Canvas
333
- | Event | Mode | Cancelable | Payload Keys |
334
- | --- | --- | --- | --- |
335
- | afterZoomChange | emit | No | newZoom, oldZoom, sheet |
336
- | beforeZoomChange | emit | No | newZoom, oldZoom, sheet |
337
-
338
- ### Comment
339
- | Event | Mode | Cancelable | Payload Keys |
340
- | --- | --- | --- | --- |
341
- | event | emit | No | - |
1
+ # Event API
2
+
3
+ > Generated: 2026-06-14
4
+
5
+ ## Subscription surface
6
+
7
+ Use `SN.Event` for registration and dispatch. `SN.Event` is an `EventEmitter` instance exposed on the root workbook object.
8
+
9
+ ```js
10
+ SN.Event.on('beforeCellEdit', (e) => {
11
+ if (e.data.cell?.locked) e.cancel('Cell is locked')
12
+ })
13
+
14
+ SN.Event.once('afterSheetAdd', (e) => {
15
+ console.log(e.data.sheet)
16
+ })
17
+ ```
18
+
19
+ ## EventEmitter
20
+ - Event Transmitter
21
+
22
+ ### Methods
23
+ #### `on(event, handler, options = {}): EventEmitter`
24
+ - Register Event Listener
25
+
26
+ **Parameters**
27
+ | Name | Type | Required | Default | Description |
28
+ | --- | --- | --- | --- | --- |
29
+ | event | string | Yes | - | Event Name |
30
+ | handler | Function | Yes | - | Handling function |
31
+ | options | Object | No | {} | Options |
32
+ | options.id | string | Yes | - | Unique identity (anti duplicate binding) |
33
+ | options.priority | number | Yes | - | Priority (execute as soon as possible) |
34
+ | options.once | boolean | Yes | - | Whether to execute only once |
35
+
36
+ **Returns**
37
+ - Type: `EventEmitter`
38
+ - Chain Calls Supported
39
+
40
+ #### `once(event, handler, options = {}): EventEmitter`
41
+ - Sign up for a one-time event listener
42
+
43
+ **Parameters**
44
+ | Name | Type | Required | Default | Description |
45
+ | --- | --- | --- | --- | --- |
46
+ | event | string | Yes | - | Event Name |
47
+ | handler | Function | Yes | - | Handling function |
48
+ | options | Object | No | {} | Options |
49
+
50
+ **Returns**
51
+ - Type: `EventEmitter`
52
+
53
+ #### `off(event, idOrHandler): EventEmitter`
54
+ - Remove Event Listener
55
+
56
+ **Parameters**
57
+ | Name | Type | Required | Default | Description |
58
+ | --- | --- | --- | --- | --- |
59
+ | event | string | Yes | - | Event Name |
60
+ | idOrHandler | string \| Function | Yes | - | id or handler reference |
61
+
62
+ **Returns**
63
+ - Type: `EventEmitter`
64
+
65
+ #### `offAll(): EventEmitter`
66
+ - Remove all event listeners
67
+
68
+ **Returns**
69
+ - Type: `EventEmitter`
70
+
71
+ #### `emit(event, data = {}): SheetEvent`
72
+ - Trigger event
73
+
74
+ **Parameters**
75
+ | Name | Type | Required | Default | Description |
76
+ | --- | --- | --- | --- | --- |
77
+ | event | string | Yes | - | Event Name |
78
+ | data | Object | No | {} | Event Data |
79
+
80
+ **Returns**
81
+ - Type: `SheetEvent`
82
+ - Event object (canceled status can be checked)
83
+
84
+ #### `async emitAsync(event, data = {}): Promise<SheetEvent>`
85
+ - Trigger event with async hooks support.
86
+
87
+ **Parameters**
88
+ | Name | Type | Required | Default | Description |
89
+ | --- | --- | --- | --- | --- |
90
+ | event | string | Yes | - | event name |
91
+ | data | Object | No | {} | event data |
92
+
93
+ **Returns**
94
+ - Type: `Promise<SheetEvent>`
95
+
96
+ #### `hasListeners(event): boolean`
97
+ - Check for listeners
98
+
99
+ **Parameters**
100
+ | Name | Type | Required | Default | Description |
101
+ | --- | --- | --- | --- | --- |
102
+ | event | string | Yes | - | Event Name |
103
+
104
+ **Returns**
105
+ - Type: `boolean`
106
+
107
+ #### `listenerCount(event): number`
108
+ - Get the number of listeners
109
+
110
+ **Parameters**
111
+ | Name | Type | Required | Default | Description |
112
+ | --- | --- | --- | --- | --- |
113
+ | event | string | Yes | - | Event name (optional, return total if not passed) |
114
+
115
+ **Returns**
116
+ - Type: `number`
117
+
118
+ #### `listEvents(): Array<{event: string, count: number}>`
119
+ - Get all event names and number of monitors
120
+
121
+ **Returns**
122
+ - Type: `Array<{event: string, count: number}>`
123
+
124
+ ## SheetEvent
125
+ - Event object
126
+
127
+ ### Props
128
+ | Name | Type | Static | Default | Description |
129
+ | --- | --- | --- | --- | --- |
130
+ | type | string | No | type | - |
131
+ | data | Object | No | data | - |
132
+ | target | Object | No | target | - |
133
+ | canceled | boolean | No | false | - |
134
+ | stopped | boolean | No | false | - |
135
+ | cancelReason | null | No | null | - |
136
+ | timestamp | number | No | Date.now() | - |
137
+
138
+ ### Methods
139
+ #### `cancel(reason = '')`
140
+ - Cancel event (block default behavior)
141
+
142
+ **Parameters**
143
+ | Name | Type | Required | Default | Description |
144
+ | --- | --- | --- | --- | --- |
145
+ | reason | string | No | '' | Reason for canceling (optional, used as a reminder) |
146
+
147
+ #### `stopPropagation()`
148
+ - Stop event propagation (no longer performing follow-up listener)
149
+
150
+ #### `waitUntil(promise)`
151
+ - Register async work for emitAsync to await.
152
+
153
+ **Parameters**
154
+ | Name | Type | Required | Default | Description |
155
+ | --- | --- | --- | --- | --- |
156
+ | promise | Promise | Yes | - | - |
157
+
158
+ ## Emitted events
159
+
160
+ - Total detected events: 120
161
+ - Dynamic event patterns: 7
162
+
163
+ ### Col
164
+ | Event | Mode | Cancelable | Payload Keys |
165
+ | --- | --- | --- | --- |
166
+ | after${eventBase} | emit | No | col, newHidden, oldHidden, row, sheet |
167
+ | afterColResize | emit | No | col, newWidth, oldWidth, sheet |
168
+ | before${eventBase} | emit | No | col, newHidden, oldHidden, row, sheet |
169
+ | beforeColResize | emit | No | col, newWidth, oldWidth, sheet |
170
+
171
+ ### Sheet
172
+ | Event | Mode | Cancelable | Payload Keys |
173
+ | --- | --- | --- | --- |
174
+ | after${eventSuffix} | emit | No | [indexKey], changedCount, limitedCount, maxLevel, sheet |
175
+ | afterClearCellControl | emit | No | ...summary, sheet |
176
+ | afterClearDataValidation | emit | No | ...summary, sheet |
177
+ | afterConsolidate | emit | No | ...summary, sheet |
178
+ | afterDeleteColumns | emit | No | col, count, sheet |
179
+ | afterDeleteRows | emit | No | count, row, sheet |
180
+ | afterFlashFill | emit | No | exampleCount, filledCount, sheet, sourceRange, strategy, targetRange |
181
+ | afterInsertColumns | emit | No | col, count, sheet |
182
+ | afterInsertRows | emit | No | count, row, sheet |
183
+ | afterMerge | emit | No | areas, mode, sheet |
184
+ | afterMoveArea | emit | No | moveArea, sheet, targetArea |
185
+ | afterSelectionChange | emit | No | newAreas, newCell, oldAreas, oldCell, sheet, type |
186
+ | afterSetCellControl | emit | No | ...summary, control, sheet |
187
+ | afterSetDataValidation | emit | No | ...summary, sheet |
188
+ | afterSheetRename | emit | No | newName, oldName, sheet |
189
+ | afterSort | emit | No | options, range, sheet, sortKeys, success |
190
+ | afterSubtotal | emit | No | ...summary, options, sheet |
191
+ | afterTextToColumns | emit | No | columnCount, rowCount, sheet, sourceRange, targetRange |
192
+ | afterUnmerge | emit | No | cellAd, sheet |
193
+ | before${eventSuffix} | emit | No | [indexKey], areas, maxLevel, sheet |
194
+ | beforeClearCellControl | emit | No | areas, sheet |
195
+ | beforeClearDataValidation | emit | No | areas, sheet |
196
+ | beforeConsolidate | emit | No | functionName, sheet, skipBlanks, sourceRanges, targetRange |
197
+ | beforeDeleteColumns | emit | No | col, count, sheet |
198
+ | beforeDeleteRows | emit | No | count, row, sheet |
199
+ | beforeFlashFill | emit | No | exampleCount, sheet, sourceRange, strategy, targetRange |
200
+ | beforeInsertColumns | emit | No | col, count, sheet |
201
+ | beforeInsertRows | emit | No | count, row, sheet |
202
+ | beforeMerge | emit | No | areas, mode, sheet |
203
+ | beforeMoveArea | emit | No | moveArea, sheet, targetArea |
204
+ | beforeSelectionChange | emit | No | newAreas, newCell, oldAreas, oldCell, sheet, type |
205
+ | beforeSetCellControl | emit | No | areas, control, sheet |
206
+ | beforeSetDataValidation | emit | No | areas, rule, sheet |
207
+ | beforeSheetRename | emit | No | newName, oldName, sheet |
208
+ | beforeSort | emit | No | options, range, sheet, sortKeys |
209
+ | beforeSubtotal | emit | No | options, range, sheet |
210
+ | beforeTextToColumns | emit | No | options, sheet, sourceRange, targetRange |
211
+ | beforeUnmerge | emit | No | cellAd, sheet |
212
+
213
+ ### Workbook
214
+ | Event | Mode | Cancelable | Payload Keys |
215
+ | --- | --- | --- | --- |
216
+ | afterActiveSheetChange | emit | No | newSheet, oldSheet |
217
+ | afterOperation | emitAsync | No | - |
218
+ | afterOperation:${op.type} | emitAsync | No | - |
219
+ | afterSheetAdd | emit | No | name, sheet |
220
+ | afterSheetDelete | emit | No | index, name, sheet |
221
+ | afterSheetMove | emit | No | fromIndex, sheet, toIndex |
222
+ | afterWorkbookRename | emit | No | newName, oldName |
223
+ | beforeActiveSheetChange | emit | No | newSheet, oldSheet |
224
+ | beforeOperation | emit | No | ...data, operation |
225
+ | beforeOperation:${type} | emit | No | ...data, operation |
226
+ | beforeSheetAdd | emit | No | name |
227
+ | beforeSheetDelete | emit | No | index, name, sheet |
228
+ | beforeSheetMove | emit | No | fromIndex, sheet, toIndex |
229
+ | beforeWorkbookRename | emit | No | newName, oldName |
230
+
231
+ ### AI
232
+ | Event | Mode | Cancelable | Payload Keys |
233
+ | --- | --- | --- | --- |
234
+ | afterAIRequest | emitAsync | No | durationMs, request, response, result, status, textBlock, ui |
235
+ | aiRequestChunk | emit | No | chunk, chunkIndex, request, textBlock, ui |
236
+ | aiRequestError | emitAsync | No | durationMs, error, request, response, status, textBlock, ui |
237
+ | aiRequestFinally | emitAsync | No | durationMs, error, request, response, result, status, textBlock, ui |
238
+ | aiRequestStart | emit | No | request, textBlock, ui |
239
+ | beforeAIRequest | emitAsync | No | request, textBlock, ui |
240
+
241
+ ### AutoFilter
242
+ | Event | Mode | Cancelable | Payload Keys |
243
+ | --- | --- | --- | --- |
244
+ | afterAutoFilterApply | emit | No | ...eventBase, allHiddenRowsAdded, allHiddenRowsRemoved, hiddenRowsAdded, hiddenRowsRemoved, range, sheet |
245
+ | afterAutoFilterClear | emit | No | ...eventBase, range, ref, sheet |
246
+ | afterAutoFilterClearAllFilters | emit | No | ...eventBase, sheet |
247
+ | afterAutoFilterClearColumnFilter | emit | No | ...eventBase, colIndex, prevFilter, sheet |
248
+ | afterAutoFilterSetColumnFilter | emit | No | ...eventBase, colIndex, filter, prevFilter, sheet |
249
+ | afterAutoFilterSetRange | emit | No | ...eventBase, range, sheet |
250
+ | beforeAutoFilter | emit | No | ...eventBase, action, colIndex, filter, range, sheet |
251
+ | beforeAutoFilterApply | emit | No | ...eventBase, columns, range, sheet |
252
+ | beforeAutoFilterClear | emit | No | ...eventBase, range, ref, sheet |
253
+ | beforeAutoFilterClearAllFilters | emit | No | ...eventBase, filters, sheet |
254
+ | beforeAutoFilterClearColumnFilter | emit | No | ...eventBase, colIndex, prevFilter, sheet |
255
+ | beforeAutoFilterSetColumnFilter | emit | No | ...eventBase, colIndex, filter, prevFilter, sheet |
256
+ | beforeAutoFilterSetRange | emit | No | ...eventBase, range, sheet |
257
+
258
+ ### Cell
259
+ | Event | Mode | Cancelable | Payload Keys |
260
+ | --- | --- | --- | --- |
261
+ | afterCellEdit | emit | No | cell, col, newValue, oldValue, row, sheet |
262
+ | afterCellStyleChange | emit | No | cell, col, newStyle, oldStyle, row, sheet |
263
+ | afterHyperlinkInsert | emit | No | cell, col, hyperlink, row, sheet |
264
+ | beforeCellEdit | emit | No | cell, col, newValue, oldValue, row, sheet |
265
+ | beforeCellStyleChange | emit | No | cell, col, newStyle, oldStyle, row, sheet |
266
+ | beforeHyperlinkInsert | emit | No | cell, col, hyperlink, row, sheet |
267
+
268
+ ### Drawing
269
+ | Event | Mode | Cancelable | Payload Keys |
270
+ | --- | --- | --- | --- |
271
+ | afterDrawingAdd | emit | No | config, drawing, sheet |
272
+ | afterDrawingRemove | emit | No | drawing, id, sheet |
273
+ | beforeDrawingAdd | emit | No | config, sheet |
274
+ | beforeDrawingRemove | emit | No | drawing, id, sheet |
275
+
276
+ ### PivotTable
277
+ | Event | Mode | Cancelable | Payload Keys |
278
+ | --- | --- | --- | --- |
279
+ | afterPivotTableAdd | emit | No | config, pivotTable, sheet |
280
+ | afterPivotTableChange | emit | No | action, pivotTable, sheet, sourceRangeRef, sourceSheet |
281
+ | beforePivotTableAdd | emit | No | config, sheet |
282
+ | beforePivotTableChange | emit | No | action, pivotTable, sheet, sourceRangeRef, sourceSheet |
283
+
284
+ ### UndoRedo
285
+ | Event | Mode | Cancelable | Payload Keys |
286
+ | --- | --- | --- | --- |
287
+ | afterRedo | emit | No | tx |
288
+ | afterUndo | emit | No | tx |
289
+ | beforeRedo | emit | No | tx |
290
+ | beforeUndo | emit | No | tx |
291
+
292
+ ### Row
293
+ | Event | Mode | Cancelable | Payload Keys |
294
+ | --- | --- | --- | --- |
295
+ | afterRowResize | emit | No | newHeight, oldHeight, row, sheet |
296
+ | beforeRowResize | emit | No | newHeight, oldHeight, row, sheet |
297
+
298
+ ### Slicer
299
+ | Event | Mode | Cancelable | Payload Keys |
300
+ | --- | --- | --- | --- |
301
+ | afterSlicerAdd | emit | No | config, sheet, slicer |
302
+ | afterSlicerRemove | emit | No | id, sheet, slicer |
303
+ | beforeSlicerAdd | emit | No | config, sheet |
304
+ | beforeSlicerRemove | emit | No | id, sheet, slicer |
305
+
306
+ ### Sparkline
307
+ | Event | Mode | Cancelable | Payload Keys |
308
+ | --- | --- | --- | --- |
309
+ | afterSparklineAdd | emit | No | config, sheet, sparkline |
310
+ | afterSparklineRemove | emit | No | c, r, sheet, sparkline |
311
+ | beforeSparklineAdd | emit | No | config, sheet |
312
+ | beforeSparklineRemove | emit | No | c, r, sheet, sparkline |
313
+
314
+ ### Table
315
+ | Event | Mode | Cancelable | Payload Keys |
316
+ | --- | --- | --- | --- |
317
+ | afterTableAdd | emit | No | options, sheet, table |
318
+ | afterTableAutoFilterToggle | emit | No | newValue, oldValue, sheet, table |
319
+ | afterTableRemove | emit | No | id, sheet, table |
320
+ | afterTableRename | emit | No | newName, oldName, sheet, table |
321
+ | afterTableResize | emit | No | newRef, oldRef, sheet, table |
322
+ | afterTableStyleChange | emit | No | newStyle, oldStyle, sheet, table |
323
+ | afterTableTotalsRowToggle | emit | No | newValue, oldValue, sheet, table |
324
+ | beforeTableAdd | emit | No | options, sheet |
325
+ | beforeTableAutoFilterToggle | emit | No | newValue, oldValue, sheet, table |
326
+ | beforeTableRemove | emit | No | id, sheet, table |
327
+ | beforeTableRename | emit | No | newName, oldName, sheet, table |
328
+ | beforeTableResize | emit | No | newRef, oldRef, sheet, table |
329
+ | beforeTableStyleChange | emit | No | newStyle, oldStyle, sheet, table |
330
+ | beforeTableTotalsRowToggle | emit | No | newValue, oldValue, sheet, table |
331
+
332
+ ### Canvas
333
+ | Event | Mode | Cancelable | Payload Keys |
334
+ | --- | --- | --- | --- |
335
+ | afterZoomChange | emit | No | newZoom, oldZoom, sheet |
336
+ | beforeZoomChange | emit | No | newZoom, oldZoom, sheet |
337
+
338
+ ### Comment
339
+ | Event | Mode | Cancelable | Payload Keys |
340
+ | --- | --- | --- | --- |
341
+ | event | emit | No | - |