@univerjssheets-thread-commentfacadeinterfacesIfrangecommentmixin

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


Interface: IFRangeCommentMixin

Methods

addComment()

addComment(this, content): Promise<boolean>

Add a comment to the start cell in the current range.

Parameters

ParameterTypeDescription
thisFRange-
contentIDocumentBodyThe content of the comment.

Returns

Promise<boolean>

Whether the comment is added successfully.

Defined in

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


clearComment()

clearComment(): Promise<boolean>

Clear the comment of the start cell in the current range.

Returns

Promise<boolean>

Whether the comment is cleared successfully.

Defined in

sheets-thread-comment/src/facade/f-range.ts:39


getComment()

getComment(): Nullable<FThreadComment>

Get the comment of the start cell in the current range.

Returns

Nullable<FThreadComment>

The comment of the start cell in the current range. If the cell does not have a comment, return null.

Defined in

sheets-thread-comment/src/facade/f-range.ts:28