@univerjsrpcclassesDatasyncprimarycontroller

@univerjs/rpc v0.5.0-beta.1Docs


Class: DataSyncPrimaryController

This controller is responsible for syncing data from the primary thread to the worker thread.

Note that only spreadsheets will be synced to the remote calculation instance by default.

Extends

Constructors

new DataSyncPrimaryController()

new DataSyncPrimaryController(
   _injector, 
   _commandService, 
   _univerInstanceService, 
   _rpcChannelService, 
   _remoteSyncService): DataSyncPrimaryController

Parameters

ParameterType
_injectorInjector
_commandServiceICommandService
_univerInstanceServiceIUniverInstanceService
_rpcChannelServiceIRPCChannelService
_remoteSyncServiceIRemoteSyncService

Returns

DataSyncPrimaryController

Overrides

RxDisposable.constructor

Defined in

submodules/univer/packages/rpc/src/controllers/data-sync/data-sync-primary.controller.ts:52

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseRxDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93
dispose$protectedSubject<void>undefinedRxDisposable.dispose$submodules/univer/packages/core/src/shared/lifecycle.ts:117

Methods

dispose()

dispose(): void

Returns

void

Inherited from

RxDisposable.dispose

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:119


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100


registerSyncingMutations()

registerSyncingMutations(mutation): void

Parameters

ParameterType
mutationIMutation<object, boolean>

Returns

void

Defined in

submodules/univer/packages/rpc/src/controllers/data-sync/data-sync-primary.controller.ts:65


syncUnit()

syncUnit(unitId): IDisposable

Only spreadsheets would be synced to the web worker in normal situations. If you would like to sync other types of documents, you should manually call this method with that document’s id.

Parameters

ParameterType
unitIdstring

Returns

IDisposable

Defined in

submodules/univer/packages/rpc/src/controllers/data-sync/data-sync-primary.controller.ts:73