@univerjsengine-renderclassesRendermanagerservice

@univerjs/engine-render v0.5.4


Class: RenderManagerService

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:89

Extends

Implements

Constructors

new RenderManagerService()

new RenderManagerService(_injector, _univerInstanceService): RenderManagerService

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:118

Parameters

ParameterType
_injectorInjector
_univerInstanceServiceIUniverInstanceService

Returns

RenderManagerService

Overrides

Disposable.constructor

Properties

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
_disposedprotectedbooleanfalse-Disposable._disposedpackages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96
created$readonlyObservable<IRender>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:104
createRender$readonlyObservable<string>undefinedDeprecated-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:101
currentRender$readonlyObservable<Nullable<string>>undefinedDeprecated-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:97
disposed$readonlyObservable<string>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:107

Accessors

defaultEngine

Get Signature

get defaultEngine(): Engine

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:109

Returns

Engine

Implementation of

IRenderManagerService.defaultEngine

Methods

_createRender()

protected _createRender(
   unitId, 
   engine, 
   isMainScene): IRender

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:248

create renderUnit & init deps from renderDependencies by renderUnit’s type

Parameters

ParameterTypeDefault value
unitIdstringundefined
engineEngineundefined
isMainScenebooleantrue

Returns

IRender

renderUnit:IRender


addRender()

addRender(unitId, renderUnit): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:307

Parameters

ParameterType
unitIdstring
renderUnitIRender

Returns

void

Implementation of

IRenderManagerService.addRender


create()

create(unitId): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:189

Parameters

ParameterType
unitIdstring

Returns

void

Deprecated

this design is very very weird! Remove it.

Implementation of

IRenderManagerService.create


createRender()

createRender(unitId): IRender

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:198

create renderUnit & init deps from renderDependencies

Parameters

ParameterType
unitIdstring

Returns

IRender

renderUnit:IRender

Implementation of

IRenderManagerService.createRender


dispose()

dispose(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:125

Returns

void

Implementation of

IRenderManagerService.dispose

Overrides

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed


getAllRenderersOfType()

getAllRenderersOfType(type): RenderUnit[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:204

Parameters

ParameterType
typeUniverInstanceType

Returns

RenderUnit[]

Implementation of

IRenderManagerService.getAllRenderersOfType


getCurrent()

getCurrent(): Nullable<IRender>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:334

Returns

Nullable<IRender>

Deprecated

There will be multi units to render at the same time, so there is no current.

Implementation of

IRenderManagerService.getCurrent


getCurrentTypeOfRenderer()

getCurrentTypeOfRenderer(type): Nullable<RenderUnit>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:216

Parameters

ParameterType
typeUniverInstanceType

Returns

Nullable<RenderUnit>

Implementation of

IRenderManagerService.getCurrentTypeOfRenderer


getFirst()

getFirst(): Nullable<IRender>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:338

Returns

Nullable<IRender>

Deprecated

There will be multi units to render at the same time, so there is no first.

Implementation of

IRenderManagerService.getFirst


getRenderAll()

getRenderAll(): Map<string, IRender>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:351

Returns

Map<string, IRender>

Implementation of

IRenderManagerService.getRenderAll


getRenderById()

getRenderById(unitId): Nullable<IRender>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:347

get RenderUnit from this._renderMap

Parameters

ParameterType
unitIdstring

Returns

Nullable<IRender>

RenderUnit, aka IRender

Implementation of

IRenderManagerService.getRenderById


has()

has(unitId): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:324

Parameters

ParameterType
unitIdstring

Returns

boolean

Implementation of

IRenderManagerService.has


registerRenderModule()

registerRenderModule(type, depCtor): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:162

add dep to _renderDependencies(type, dep)

Parameters

ParameterType
typenumber
depCtorDependency

Returns

IDisposable

Implementation of

IRenderManagerService.registerRenderModule


registerRenderModules()

registerRenderModules(type, deps): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:137

Parameters

ParameterType
typenumber
depsDependency[]

Returns

IDisposable


removeRender()

removeRender(unitId): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:315

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IRenderManagerService.removeRender


setCurrent()

setCurrent(unitId): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:328

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IRenderManagerService.setCurrent


withCurrentTypeOfUnit()

withCurrentTypeOfUnit<T>(type, id): Nullable<T>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:223

Type Parameters

Type Parameter
T

Parameters

ParameterType
typeUniverInstanceType
idDependencyIdentifier<T>

Returns

Nullable<T>

Implementation of

IRenderManagerService.withCurrentTypeOfUnit