API Reference
@univerjs
@univerjs/sheets-thread-comment
classes
Sheetsthreadcommentmodel

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


Class: SheetsThreadCommentModel

Extends

Constructors

new SheetsThreadCommentModel()

new SheetsThreadCommentModel(_threadCommentModel, _univerInstanceService): SheetsThreadCommentModel

Parameters

ParameterType
_threadCommentModelThreadCommentModel
_univerInstanceServiceIUniverInstanceService

Returns

SheetsThreadCommentModel

Overrides

Disposable.constructor

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:35 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
commentUpdate$publicObservable<SheetCommentUpdate>undefined-packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:33 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


getAllByLocation()

getAllByLocation(
   unitId, 
   subUnitId, 
   row, 
   column): IThreadComment[]

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

IThreadComment[]

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:236 (opens in a new tab)


getByLocation()

getByLocation(
   unitId, 
   subUnitId, 
   row, 
   column): undefined | string

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

undefined | string

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:230 (opens in a new tab)


getComment()

getComment(
   unitId, 
   subUnitId, 
   commentId): undefined | IThreadComment

Parameters

ParameterType
unitIdstring
subUnitIdstring
commentIdstring

Returns

undefined | IThreadComment

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:246 (opens in a new tab)


getCommentWithChildren()

getCommentWithChildren(
   unitId, 
   subUnitId, 
   row, 
column): Nullable<IThreadInfo>

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

Nullable<IThreadInfo>

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:250 (opens in a new tab)


getSubUnitAll()

getSubUnitAll(unitId, subUnitId): IThreadComment[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IThreadComment[]

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:276 (opens in a new tab)


showCommentMarker()

showCommentMarker(
   unitId, 
   subUnitId, 
   row, 
   column): boolean

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

boolean

Defined in

packages/sheets-thread-comment-base/src/models/sheets-thread-comment.model.ts:262 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.