@univerjs-pro/collaboration-client v0.5.4

Class: CollaborativeUndoRedoService

Defined in: packages/collaboration-client/src/services/undoredo/collaborative-undoredo.service.ts:13

This UndoRedoService is local.

Extends

• LocalUndoRedoService

Implements

• ICollaborativeUndoRedoService

Constructors

new CollaborativeUndoRedoService()

new CollaborativeUndoRedoService(
   _currentUniverSheet, 
   _commandService, 
   _contextService, 
   _transformService, 
   _logService): CollaborativeUndoRedoService

Defined in: packages/collaboration-client/src/services/undoredo/collaborative-undoredo.service.ts:14

Parameters

Returns

CollaborativeUndoRedoService

Overrides

LocalUndoRedoService.constructor

Properties

Methods

__tempBatchingUndoRedo()

__tempBatchingUndoRedo(unitId): IDisposable

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:274

Batch undo redo elements into a single IUndoRedoItem util the returned IDisposable is called.

Parameters

Returns

IDisposable

a disposable to cancel batching undo redo elements

Deprecated

This is a temporary solution. We are going to refactor the undo redo service shortly.

Implementation of

ICollaborativeUndoRedoService.__tempBatchingUndoRedo

Inherited from

LocalUndoRedoService.__tempBatchingUndoRedo

_getRedoStack()

Call Signature

protected _getRedoStack(unitId): 
  | null
  | IUndoRedoItem[]

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:306

Parameters

Returns

| null | IUndoRedoItem[]

Inherited from

LocalUndoRedoService._getRedoStack

Call Signature

protected _getRedoStack(unitId, createAsNeeded): IUndoRedoItem[]

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:307

Parameters

Returns

IUndoRedoItem[]

Inherited from

LocalUndoRedoService._getRedoStack

_getRedoStackForFocused()

protected _getRedoStackForFocused(): IUndoRedoItem[]

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:328

Returns

IUndoRedoItem[]

Inherited from

LocalUndoRedoService._getRedoStackForFocused

_getUndoStack()

Call Signature

protected _getUndoStack(unitId): 
  | null
  | IUndoRedoItem[]

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:294

Parameters

Returns

| null | IUndoRedoItem[]

Inherited from

LocalUndoRedoService._getUndoStack

Call Signature

protected _getUndoStack(unitId, createAsNeeded): IUndoRedoItem[]

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:295

Parameters

Returns

IUndoRedoItem[]

Inherited from

LocalUndoRedoService._getUndoStack

_getUndoStackForFocused()

protected _getUndoStackForFocused(): IUndoRedoItem[]

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:318

Returns

IUndoRedoItem[]

Inherited from

LocalUndoRedoService._getUndoStackForFocused

_updateStatus()

protected _updateStatus(): void

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:283

Returns

void

Inherited from

LocalUndoRedoService._updateStatus

clearUndoRedo()

clearUndoRedo(unitID): void

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:220

Parameters

Returns

void

Implementation of

ICollaborativeUndoRedoService.clearUndoRedo

Inherited from

LocalUndoRedoService.clearUndoRedo

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

LocalUndoRedoService.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Returns

IDisposable

Inherited from

LocalUndoRedoService.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

LocalUndoRedoService.ensureNotDisposed

pitchTopRedoElement()

pitchTopRedoElement(): Nullable<IUndoRedoItem>

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:239

Pitch the top undo element of the currently focused Univer document instance.

Returns

Nullable<IUndoRedoItem>

Implementation of

ICollaborativeUndoRedoService.pitchTopRedoElement

Inherited from

LocalUndoRedoService.pitchTopRedoElement

pitchTopUndoElement()

pitchTopUndoElement(): Nullable<IUndoRedoItem>

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:234

Pitch the top redo element of the currently focused Univer document instance.

Returns

Nullable<IUndoRedoItem>

Implementation of

ICollaborativeUndoRedoService.pitchTopUndoElement

Inherited from

LocalUndoRedoService.pitchTopUndoElement

popRedoToUndo()

popRedoToUndo(): void

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:264

Returns

void

Implementation of

ICollaborativeUndoRedoService.popRedoToUndo

Inherited from

LocalUndoRedoService.popRedoToUndo

popUndoToRedo()

popUndoToRedo(): void

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:254

Returns

void

Implementation of

ICollaborativeUndoRedoService.popUndoToRedo

Inherited from

LocalUndoRedoService.popUndoToRedo

pushUndoRedo()

pushUndoRedo(item): void

Defined in: submodules/univer/packages/core/src/services/undoredo/undoredo.service.ts:187

Parameters

Returns

void

Implementation of

ICollaborativeUndoRedoService.pushUndoRedo

Inherited from

LocalUndoRedoService.pushUndoRedo

transformUndoRedo()

transformUndoRedo(unitID, changesets): void

Defined in: packages/collaboration-client/src/services/undoredo/collaborative-undoredo.service.ts:24

Parameters

Returns

void

Implementation of

ICollaborativeUndoRedoService.transformUndoRedo