@univerjs/find-replace v0.1.17 • Docs
Class: abstract FindModel
Extends
Constructors
new FindModel()
new FindModel(): FindModelReturns
Inherited from
Properties
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|---|
_disposed | protected | boolean | false | - | Disposable._disposed | packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
activelyChangingMatch$ | abstract | Observable<IFindMatch<unknown>> | undefined | - | - | packages/find-replace/src/services/find-replace.service.ts:68 (opens in a new tab) |
matchesUpdate$ | abstract | Observable<IFindMatch<unknown>[]> | undefined | Find model should emit new matches from this observable if they changed no matter due to incremental or document's content changes. | - | packages/find-replace/src/services/find-replace.service.ts:67 (opens in a new tab) |
unitId | abstract | string | undefined | - | - | packages/find-replace/src/services/find-replace.service.ts:61 (opens in a new tab) |
Methods
dispose()
dispose(): voidReturns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposableParameters
| Parameter | Type |
|---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): voidReturns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getMatches()
abstract getMatches(): IFindMatch<unknown>[]Returns
IFindMatch<unknown>[]
Defined in
packages/find-replace/src/services/find-replace.service.ts:70 (opens in a new tab)
moveToNextMatch()
abstract moveToNextMatch(params?): null | IFindMatch<unknown>Parameters
| Parameter | Type |
|---|---|
params? | IFindMoveParams |
Returns
null | IFindMatch<unknown>
Defined in
packages/find-replace/src/services/find-replace.service.ts:72 (opens in a new tab)
moveToPreviousMatch()
abstract moveToPreviousMatch(params?): null | IFindMatch<unknown>Parameters
| Parameter | Type |
|---|---|
params? | IFindMoveParams |
Returns
null | IFindMatch<unknown>
Defined in
packages/find-replace/src/services/find-replace.service.ts:73 (opens in a new tab)
replace()
abstract replace(replaceString): Promise<boolean>Replace the currently focused matching if there is one.
Parameters
| Parameter | Type |
|---|---|
replaceString | string |
Returns
Promise<boolean>
Defined in
packages/find-replace/src/services/find-replace.service.ts:76 (opens in a new tab)
replaceAll()
abstract replaceAll(replaceString): Promise<IReplaceAllResult>Replace all matches. This method would return how many
Parameters
| Parameter | Type |
|---|---|
replaceString | string |
Returns
Promise<IReplaceAllResult>
Defined in
packages/find-replace/src/services/find-replace.service.ts:81 (opens in a new tab)