@univerjs/sheets-thread-comment v0.5.1Docs


Interface: IFWorkbookThreadCommentMixin

Methods

onBeforeAddThreadComment()

onBeforeAddThreadComment(this, callback): IDisposable

The onThreadCommentChange event is fired when the thread comment of this sheet is changed.

Parameters

ParameterTypeDescription
thisFWorkbook-
callback(params, options) => false | voidCallback 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

sheets-thread-comment/src/facade/f-workbook.ts:41


onBeforeDeleteThreadComment()

onBeforeDeleteThreadComment(this, callback): IDisposable

The onBeforeDeleteThreadComment event is fired before the thread comment is deleted.

Parameters

ParameterTypeDescription
thisFWorkbook-
callback(params, options) => false | voidCallback 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

sheets-thread-comment/src/facade/f-workbook.ts:61


onBeforeUpdateThreadComment()

onBeforeUpdateThreadComment(this, callback): IDisposable

The onBeforeUpdateThreadComment event is fired before the thread comment is updated.

Parameters

ParameterTypeDescription
thisFWorkbook-
callback(params, options) => false | voidCallback 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

sheets-thread-comment/src/facade/f-workbook.ts:51


onThreadCommentChange()

onThreadCommentChange(callback): IDisposable

The onThreadCommentChange event is fired when the thread comment of this sheet is changed.

Parameters

ParameterTypeDescription
callback(commentUpdate) => false | voidCallback 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

sheets-thread-comment/src/facade/f-workbook.ts:34