@univerjs/sheets-ui v0.5.1 • Docs

Interface: IFSheetHooksUIMixin

Methods

onAfterCellEdit()

onAfterCellEdit(callback): IDisposable

The onAfterCellEdit event is fired after a cell is edited.

Parameters

Parameter	Type	Description
`callback`	(`params`) => `void`	Callback function that will be called when the event is fired

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:74

onBeforeCellEdit()

onBeforeCellEdit(callback): IDisposable

The onBeforeCellEdit event is fired before a cell is edited.

Parameters

Parameter	Type	Description
`callback`	(`params`) => `void`	Callback function that will be called when the event is fired

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:67

onCellDragOver()

onCellDragOver(callback): IDisposable

The onCellDragOver event is fired when an element or text selection is being dragged into a cell’s hit test boundaries.

Parameters

Parameter	Type	Description
`callback`	(`cellPos`) => `void`	Callback function that will be called when the event is fired

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:44

onCellDrop()

onCellDrop(callback): IDisposable

The onCellDrop event is fired when an element or text selection is being dropped on the cell.

Parameters

Parameter	Type	Description
`callback`	(`cellPos`) => `void`	Callback function that will be called when the event is fired

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:51

onCellPointerMove()

onCellPointerMove(callback): IDisposable

The onCellPointerMove event is fired when a pointer changes coordinates.

Parameters

Parameter	Type	Description
`callback`	(`cellPos`) => `void`	Callback function that will be called when the event is fired

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:30

onCellPointerOver()

onCellPointerOver(callback): IDisposable

The onCellPointerOver event is fired when a pointer is moved into a cell’s hit test boundaries.

Parameters

Parameter	Type	Description
`callback`	(`cellPos`) => `void`	Callback function that will be called when the event is fired

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:37

onCellRender()

onCellRender(
   customRender, 
   effect?, 
   priority?): IDisposable

The onCellRender event is fired when a cell is rendered.

Parameters

Parameter	Type	Description
`customRender`	`Nullable`<`ICellCustomRender`[]>	Custom render function
`effect`?	`InterceptorEffectEnum`	The effect of the interceptor
`priority`?	`number`	The priority of the interceptor

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Defined in

submodules/univer/packages/sheets-ui/src/facade/f-sheet-hooks.ts:60

Ifpermissionsheetsuimixin Ifuniversheetsuimixin