@univerjs/docs-mention v0.2.11 • Docs
Class: DocMentionModel
Extends
Constructors
new DocMentionModel()
new DocMentionModel(): DocMentionModel
Returns
Inherited from
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | core/src/shared/lifecycle.ts:93 (opens in a new tab) |
Methods
addMention()
addMention(unitId, mention): void
Parameters
Parameter | Type |
---|---|
unitId | string |
mention | IDocMention |
Returns
void
Defined in
docs-mention/src/models/doc-mention.model.ts:34 (opens in a new tab)
copyMention()
copyMention(unitId, id): undefined | {
extra: Record<string, any>;
id: newId;
label: string;
objectId: string;
objectType: MentionType;
}
Parameters
Parameter | Type |
---|---|
unitId | string |
id | string |
Returns
undefined
| {
extra
: Record
<string
, any
>;
id
: newId
;
label
: string
;
objectId
: string
;
objectType
: MentionType
;
}
Defined in
docs-mention/src/models/doc-mention.model.ts:44 (opens in a new tab)
deleteMention()
deleteMention(unitId, id): boolean
Parameters
Parameter | Type |
---|---|
unitId | string |
id | string |
Returns
boolean
Defined in
docs-mention/src/models/doc-mention.model.ts:56 (opens in a new tab)
deleteUnit()
deleteUnit(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
docs-mention/src/models/doc-mention.model.ts:66 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
core/src/shared/lifecycle.ts:100 (opens in a new tab)
getMention()
getMention(unitId, id): undefined | IDocMention
Parameters
Parameter | Type |
---|---|
unitId | string |
id | string |
Returns
undefined
| IDocMention
Defined in
docs-mention/src/models/doc-mention.model.ts:39 (opens in a new tab)
getUnit()
getUnit(unitId): IDocMention[]
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Defined in
docs-mention/src/models/doc-mention.model.ts:61 (opens in a new tab)