API Reference
@univerjs
@univerjs/engine-render
classes
Rendermanagerservice

@univerjs/engine-render v0.4.2Docs


Class: RenderManagerService

Extends

Implements

Constructors

new RenderManagerService()

new RenderManagerService(_injector, _univerInstanceService): RenderManagerService

Parameters

ParameterType
_injectorInjector
_univerInstanceServiceIUniverInstanceService

Returns

RenderManagerService

Overrides

Disposable.constructor

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:118 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
_disposedprotectedbooleanfalse-Disposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
createRender$readonlyObservable<string>undefinedDeprecated-submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:101 (opens in a new tab)
created$readonlyObservable<IRender>undefined--submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:104 (opens in a new tab)
currentRender$readonlyObservable<Nullable<string>>undefinedDeprecated-submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:97 (opens in a new tab)
disposed$readonlyObservable<string>undefined--submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:107 (opens in a new tab)

Accessors

defaultEngine

get defaultEngine(): Engine

Returns

Engine

Implementation of

IRenderManagerService.defaultEngine

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:109 (opens in a new tab)

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

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:248 (opens in a new tab)


addRender()

addRender(unitId, renderUnit): void

Parameters

ParameterType
unitIdstring
renderUnitIRender

Returns

void

Implementation of

IRenderManagerService.addRender

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:307 (opens in a new tab)


create()

create(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Deprecated

this design is very very weird! Remove it.

Implementation of

IRenderManagerService.create

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:189 (opens in a new tab)


createRender()

createRender(unitId): IRender

create renderUnit & init deps from renderDependencies

Parameters

ParameterType
unitIdstring

Returns

IRender

renderUnit:IRender

Implementation of

IRenderManagerService.createRender

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:198 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Implementation of

IRenderManagerService.dispose

Overrides

Disposable.dispose

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:125 (opens in a new tab)


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


getAllRenderersOfType()

getAllRenderersOfType(type): RenderUnit[]

Parameters

ParameterType
typeUniverInstanceType

Returns

RenderUnit[]

Implementation of

IRenderManagerService.getAllRenderersOfType

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:204 (opens in a new tab)


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

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:334 (opens in a new tab)


getCurrentTypeOfRenderer()

getCurrentTypeOfRenderer(type): Nullable<RenderUnit>

Parameters

ParameterType
typeUniverInstanceType

Returns

Nullable<RenderUnit>

Implementation of

IRenderManagerService.getCurrentTypeOfRenderer

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:216 (opens in a new tab)


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

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:338 (opens in a new tab)


getRenderAll()

getRenderAll(): Map<string, IRender>

Returns

Map<string, IRender>

Implementation of

IRenderManagerService.getRenderAll

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:351 (opens in a new tab)


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

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:347 (opens in a new tab)


has()

has(unitId): boolean

Parameters

ParameterType
unitIdstring

Returns

boolean

Implementation of

IRenderManagerService.has

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:324 (opens in a new tab)


registerRenderModule()

registerRenderModule(type, depCtor): IDisposable

add dep to _renderDependencies(type, dep)

Parameters

ParameterType
typenumber
depCtorDependency

Returns

IDisposable

Implementation of

IRenderManagerService.registerRenderModule

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:162 (opens in a new tab)


registerRenderModules()

registerRenderModules(type, deps): IDisposable

Parameters

ParameterType
typenumber
depsDependency[]

Returns

IDisposable

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:137 (opens in a new tab)


removeRender()

removeRender(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IRenderManagerService.removeRender

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:315 (opens in a new tab)


setCurrent()

setCurrent(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IRenderManagerService.setCurrent

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:328 (opens in a new tab)


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

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:223 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.