@univerjs/sheets-thread-comment v0.5.4

Class: FTheadCommentItem

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:25

Extended by

• FTheadCommentBuilder

Constructors

new FTheadCommentItem()

new FTheadCommentItem(comment?): FTheadCommentItem

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

Parameters

Returns

FTheadCommentItem

Properties

Accessors

content

Get Signature

get content(): RichTextValue

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:98

Get the content of the comment

Example

const comment = univerAPI.getActiveWorkbook()
 .getSheetById(sheetId)
 .getCommentById(commentId);
const content = comment.content;

Returns

RichTextValue

The content of the comment

dateTime

Get Signature

get dateTime(): string

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:83

Get the date time of the comment

Example

const comment = univerAPI.getActiveWorkbook()
 .getSheetById(sheetId)
 .getCommentById(commentId);
const dateTime = comment.dateTime;

Returns

string

The date time of the comment

id

Get Signature

get id(): string

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:113

Get the id of the comment

Example

const comment = univerAPI.getActiveWorkbook()
 .getSheetById(sheetId)
 .getCommentById(commentId);
const id = comment.id;

Returns

string

The id of the comment

personId

Get Signature

get personId(): string

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:68

Get the person id of the comment

Example

const comment = univerAPI.getActiveWorkbook()
 .getSheetById(sheetId)
 .getCommentById(commentId);
const personId = comment.personId;

Returns

string

The person id of the comment

threadId

Get Signature

get threadId(): string

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:128

Get the thread id of the comment

Example

const comment = univerAPI.getActiveWorkbook()
 .getSheetById(sheetId)
 .getCommentById(commentId);
const threadId = comment.threadId;

Returns

string

The thread id of the comment

Methods

copy()

copy(): FTheadCommentBuilder

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:143

Copy the comment

Returns

FTheadCommentBuilder

The comment builder

Example

const comment = univerAPI.getActiveWorkbook()
 .getSheetById(sheetId)
 .getCommentById(commentId);
const newComment = comment.copy();

create()

static create(comment?): FTheadCommentItem

Defined in: sheets-thread-comment/src/facade/f-thread-comment.ts:47

Create a new FTheadCommentItem

Parameters

Returns

FTheadCommentItem

A new instance of FTheadCommentItem

Example

const comment = univerAPI.newTheadComment();