API Reference
@univerjs
@univerjs/docs-mention
classes
Docmentionmodel

@univerjs/docs-mention v0.2.11Docs


Class: DocMentionModel

Extends

Constructors

new DocMentionModel()

new DocMentionModel(): DocMentionModel

Returns

DocMentionModel

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedcore/src/shared/lifecycle.ts:93 (opens in a new tab)

Methods

addMention()

addMention(unitId, mention): void

Parameters

ParameterType
unitIdstring
mentionIDocMention

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

ParameterType
unitIdstring
idstring

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

ParameterType
unitIdstring
idstring

Returns

boolean

Defined in

docs-mention/src/models/doc-mention.model.ts:56 (opens in a new tab)


deleteUnit()

deleteUnit(unitId): void

Parameters

ParameterType
unitIdstring

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

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)


getMention()

getMention(unitId, id): undefined | IDocMention

Parameters

ParameterType
unitIdstring
idstring

Returns

undefined | IDocMention

Defined in

docs-mention/src/models/doc-mention.model.ts:39 (opens in a new tab)


getUnit()

getUnit(unitId): IDocMention[]

Parameters

ParameterType
unitIdstring

Returns

IDocMention[]

Defined in

docs-mention/src/models/doc-mention.model.ts:61 (opens in a new tab)


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