Apryse WebViewer

Class: SpreadsheetComment

Core.SpreadsheetEditor. SpreadsheetComment

Represents a single comment or reply anchored to a spreadsheet cell.

new SpreadsheetComment()

Methods

getAuthor()

Returns the author of this comment.
Returns:
The author name.
Type
string

getCellAddress()

Returns the cell address this comment is anchored to.
Returns:
Zero-based sheet, row, and column indices.
Type
Object

getColumn()

Returns the zero-based column index of the cell this comment is anchored to.
Returns:
The column index.
Type
number

getCreatedDate()

Returns the creation date of this comment.
Returns:
The creation date.
Type
Date

getId()

Returns the unique identifier of this comment.
Returns:
The comment ID.
Type
string

getMessage()

Returns the message of this comment.
Returns:
The comment message.
Type
string

getParentComment()

Returns the parent comment of this reply, or null if it is a root comment.
Returns:
The parent comment, or null for root comments.
Type
Core.SpreadsheetEditor.SpreadsheetComment | null

getReplies()

Returns the replies to this comment. Empty for reply comments.
Returns:
Array of reply comments.
Type
Array.<Core.SpreadsheetEditor.SpreadsheetComment>

getRow()

Returns the zero-based row index of the cell this comment is anchored to.
Returns:
The row index.
Type
number

getSheetIndex()

Returns the zero-based sheet index this comment is anchored to.
Returns:
The sheet index.
Type
number

getState()

Returns the state of the thread this comment belongs to.
Returns:
The thread state.
Type
Core.SpreadsheetEditor.SpreadsheetCommentState

isReply()

Returns whether this comment is a reply to another comment.
Returns:
True if this is a reply, false if it is a root comment.
Type
boolean