@univerjsengine-renderclassesRendermanagerservice

@univerjs/engine-render v0.5.0-beta.1 • Docs


Class: RenderManagerService

Extends

Implements

Constructors

new RenderManagerService()

new RenderManagerService(_injector, _univerInstanceService): RenderManagerService

Parameters

ParameterType
_injectorInjector
_univerInstanceServiceIUniverInstanceService

Returns

RenderManagerService

Overrides

Disposable.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
_disposedprotectedbooleanfalse-Disposable._disposedpackages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
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
Returns

Engine

Implementation of

IRenderManagerService.defaultEngine

Defined in

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

Methods

_createRender()

protected _createRender(
   unitId, 
   engine, 
   isMainScene): IRender

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

Parameters

ParameterTypeDefault value
unitIdstringundefined
engineEngineundefined
isMainScenebooleantrue

Returns

IRender

renderUnit:IRender

Defined in

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


addRender()

addRender(unitId, renderUnit): void

Parameters

ParameterType
unitIdstring
renderUnitIRender

Returns

void

Implementation of

IRenderManagerService.addRender

Defined in

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


create()

create(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Deprecated

this design is very very weird! Remove it.

Implementation of

IRenderManagerService.create

Defined in

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


createRender()

createRender(unitId): IRender

create renderUnit & init deps from renderDependencies

Parameters

ParameterType
unitIdstring

Returns

IRender

renderUnit:IRender

Implementation of

IRenderManagerService.createRender

Defined in

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


dispose()

dispose(): void

Returns

void

Implementation of

IRenderManagerService.dispose

Overrides

Disposable.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100


getAllRenderersOfType()

getAllRenderersOfType(type): RenderUnit[]

Parameters

ParameterType
typeUniverInstanceType

Returns

RenderUnit[]

Implementation of

IRenderManagerService.getAllRenderersOfType

Defined in

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


getCurrent()

getCurrent(): Nullable<IRender>

Returns

Nullable<IRender>

Deprecated

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

Implementation of

IRenderManagerService.getCurrent

Defined in

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


getCurrentTypeOfRenderer()

getCurrentTypeOfRenderer(type): Nullable<RenderUnit>

Parameters

ParameterType
typeUniverInstanceType

Returns

Nullable<RenderUnit>

Implementation of

IRenderManagerService.getCurrentTypeOfRenderer

Defined in

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


getFirst()

getFirst(): Nullable<IRender>

Returns

Nullable<IRender>

Deprecated

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

Implementation of

IRenderManagerService.getFirst

Defined in

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


getRenderAll()

getRenderAll(): Map<string, IRender>

Returns

Map<string, IRender>

Implementation of

IRenderManagerService.getRenderAll

Defined in

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


getRenderById()

getRenderById(unitId): Nullable<IRender>

get RenderUnit from this._renderMap

Parameters

ParameterType
unitIdstring

Returns

Nullable<IRender>

RenderUnit, aka IRender

Implementation of

IRenderManagerService.getRenderById

Defined in

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


has()

has(unitId): boolean

Parameters

ParameterType
unitIdstring

Returns

boolean

Implementation of

IRenderManagerService.has

Defined in

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


registerRenderModule()

registerRenderModule(type, depCtor): IDisposable

add dep to _renderDependencies(type, dep)

Parameters

ParameterType
typenumber
depCtorDependency

Returns

IDisposable

Implementation of

IRenderManagerService.registerRenderModule

Defined in

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


registerRenderModules()

registerRenderModules(type, deps): IDisposable

Parameters

ParameterType
typenumber
depsDependency[]

Returns

IDisposable

Defined in

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


removeRender()

removeRender(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IRenderManagerService.removeRender

Defined in

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


setCurrent()

setCurrent(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IRenderManagerService.setCurrent

Defined in

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


withCurrentTypeOfUnit()

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
typeUniverInstanceType
idDependencyIdentifier<T>

Returns

Nullable<T>

Implementation of

IRenderManagerService.withCurrentTypeOfUnit

Defined in

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