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

@univerjs/sheets-thread-comment-base v0.1.17Docs


Class: SheetsThreadCommentModel

Extends

Constructors

new SheetsThreadCommentModel()

new SheetsThreadCommentModel(_threadCommentModel, _univerInstanceService): SheetsThreadCommentModel

Parameters

ParameterType
_threadCommentModelThreadCommentModel
_univerInstanceServiceIUniverInstanceService

Returns

SheetsThreadCommentModel

Overrides

Disposable.constructor

Defined in

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

Properties

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

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

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


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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


getByLocation()

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

undefined | string

Defined in

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


getComment()

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
commentIdstring

Returns

undefined | IThreadComment

Defined in

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


getCommentWithChildren()

getCommentWithChildren(
   unitId, 
   subUnitId, 
   row, 
   column): undefined | {
  children: childrenComments;
  relativeUsers: Set<string>;
  root: current;
}

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

undefined | { children: childrenComments; relativeUsers: Set<string>; root: current; }

Defined in

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


showCommentMarker()

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
rownumber
columnnumber

Returns

boolean

Defined in

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


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