@univerjssheets-uifacadeinterfacesIfsheetsuieventnamemixin

@univerjs/sheets-ui v0.5.4


Interface: IFSheetsUIEventNameMixin

Defined in: submodules/univer/packages/sheets-ui/src/facade/f-event.ts:146

Properties

PropertyModifierTypeDescriptionDefined in
BeforeClipboardChangereadonly"BeforeClipboardChange"Trigger this event before the clipboard content changes. Type of the event parameter is IBeforeClipboardChangeParam Example univerAPI.addEvent(univerAPI.Event.BeforeClipboardChange, (param) => { const {text, html} = param; console.log('debugger', text, html); // {text: '...', html: '...'} // if want to cancel the clipboard change param.cancel = true; })submodules/univer/packages/sheets-ui/src/facade/f-event.ts:160
BeforeClipboardPastereadonly"BeforeClipboardPaste"Trigger this event before pasting. Type of the event parameter is IBeforeClipboardPasteParam Example univerAPI.addEvent(univerAPI.Event.BeforeClipboardPaste, (param) => { const {text, html} = param; console.log('debugger', text, html); // if want to cancel the clipboard paste param.cancel = true; })submodules/univer/packages/sheets-ui/src/facade/f-event.ts:187
BeforeSheetEditEndreadonly"BeforeSheetEditEnd"Event fired before a cell edit ends See IBeforeSheetEditEndEventParams Example univerAPI.addEvent(univerAPI.Event.BeforeSheetEditEnd, (params) => { const { worksheet, workbook, row, column, value, eventType, keycode, isZenEditor } = params; });submodules/univer/packages/sheets-ui/src/facade/f-event.ts:244
BeforeSheetEditStartreadonly"BeforeSheetEditStart"Event fired before a cell is edited See IBeforeSheetEditStartEventParams Example univerAPI.addEvent(univerAPI.Event.BeforeSheetEditStart, (params) => { const { worksheet, workbook, row, column, eventType, keycode, isZenEditor } = params; });submodules/univer/packages/sheets-ui/src/facade/f-event.ts:211
CellClickedreadonly"CellClicked"Event fired when a cell is clicked Example univerAPI.getActiveWorkbook().addEvent('CellClicked', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:264
CellHoverreadonly"CellHover"Event fired when a cell is hovered Example univerAPI.getActiveWorkbook().addEvent('CellHover', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:290
CellPointerDownreadonly"CellPointerDown"Event fired when a cell is pointer down Example univerAPI.getActiveWorkbook().addEvent('CellPointerDown', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:272
CellPointerMovereadonly"CellPointerMove"Event fired when move on spreadsheet cells Example univerAPI.getActiveWorkbook().addEvent('CellPointerMove', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:298
CellPointerUpreadonly"CellPointerUp"Event fired when a cell is pointer up Example univerAPI.getActiveWorkbook().addEvent('CellPointerUp', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:281
ClipboardChangedreadonly"ClipboardChanged"Trigger this event after the clipboard content changes. Type of the event parameter is IClipboardChangedParam Example univerAPI.addEvent(univerAPI.Event.ClipboardChanged, (param) => { const {text, html} = param; console.log('debugger', text, html); // {text: '...', html: '...'} })submodules/univer/packages/sheets-ui/src/facade/f-event.ts:173
ClipboardPastedreadonly"ClipboardPasted"Trigger this event after pasting. Type of the event parameter is IClipboardPastedParam Example univerAPI.addEvent(univerAPI.Event.ClipboardPasted, (param) => { const {text, html} = param; console.log('debugger', text, html); // {text: '...', html: '...'} })submodules/univer/packages/sheets-ui/src/facade/f-event.ts:199
DragOverreadonly"DragOver"Event fired when drag over spreadsheet cells Example univerAPI.getActiveWorkbook().addEvent('DragOver', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:306
Dropreadonly"Drop"Event fired when drop on spreadsheet cells Example univerAPI.getActiveWorkbook().addEvent('Drop', (p)=> console.log(p));submodules/univer/packages/sheets-ui/src/facade/f-event.ts:315
SheetEditChangingreadonly"SheetEditChanging"Event fired when a cell is being edited See ISheetEditChangingEventParams Example univerAPI.addEvent(univerAPI.Event.SheetEditChanging, (params) => { const { worksheet, workbook, row, column, value, isZenEditor } = params; });submodules/univer/packages/sheets-ui/src/facade/f-event.ts:233
SheetEditEndedreadonly"SheetEditEnded"Event fired after a cell edit ends See ISheetEditEndedEventParams Example univerAPI.addEvent(univerAPI.Event.SheetEditEnded, (params) => { const { worksheet, workbook, row, column, eventType, keycode, isZenEditor } = params; });submodules/univer/packages/sheets-ui/src/facade/f-event.ts:255
SheetEditStartedreadonly"SheetEditStarted"Event fired after a cell is edited See ISheetEditEndedEventParams Example univerAPI.addEvent(univerAPI.Event.SheetEditStarted, (params) => { const { worksheet, workbook, row, column, eventType, keycode, isZenEditor } = params; });submodules/univer/packages/sheets-ui/src/facade/f-event.ts:222