@univerjs/sheets-ui v0.5.1 • Docs

Class: FSheetHooksUIMixin

FBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.

Extends

FSheetHooks

Implements

IFSheetHooksUIMixin

Constructors

new FSheetHooksUIMixin()

new FSheetHooksUIMixin(_injector): FSheetHooksUIMixin

Parameters

Parameter	Type
`_injector`	`Injector`

Returns

FSheetHooksUIMixin

Inherited from

FSheetHooks.constructor

Defined in

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

Properties

Property	Modifier	Type	Inherited from	Defined in
`_injector`	`readonly`	`Injector`	`FSheetHooks`.`_injector`	submodules/univer/packages/sheets/src/facade/f-sheet-hooks.ts:21

Methods

_initialize()

_initialize(): void

Returns

void

Inherited from

FSheetHooks._initialize

Defined in

submodules/univer/packages/core/src/facade/f-base.ts:33

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

Implementation of

IFSheetHooksUIMixin.onAfterCellEdit

Overrides

FSheetHooks.onAfterCellEdit

Defined in

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

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

Implementation of

IFSheetHooksUIMixin.onBeforeCellEdit

Overrides

FSheetHooks.onBeforeCellEdit

Defined in

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

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

Implementation of

IFSheetHooksUIMixin.onCellDragOver

Overrides

FSheetHooks.onCellDragOver

Defined in

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

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

Implementation of

IFSheetHooksUIMixin.onCellDrop

Overrides

FSheetHooks.onCellDrop

Defined in

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

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

Implementation of

IFSheetHooksUIMixin.onCellPointerMove

Overrides

FSheetHooks.onCellPointerMove

Defined in

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

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

Implementation of

IFSheetHooksUIMixin.onCellPointerOver

Overrides

FSheetHooks.onCellPointerOver

Defined in

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

onCellRender()

onCellRender(
   customRender, 
   effect, 
   priority): IDisposable

The onCellRender event is fired when a cell is rendered.

Parameters

Parameter	Type	Default value	Description
`customRender`	`Nullable`<`ICellCustomRender`[]>	`undefined`	Custom render function
`effect`	`InterceptorEffectEnum`	`InterceptorEffectEnum.Style`	The effect of the interceptor
`priority`	`number`	`InterceptCellContentPriority.DATA_VALIDATION`	The priority of the interceptor