@univerjs/engine-render v0.5.4


Interface: IRenderManagerService

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

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
created$Observable<IRender>--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:66
createRender$Observable<string>Deprecated-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:62
currentRender$Observable<Nullable<string>>Deprecated-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:34
defaultEngineEngine--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:54
dispose() => void-IDisposable.disposepackages/api/tmp/univer-pro/node_modules/.pnpm/@wendellhu+redi@0.17.0/node_modules/@wendellhu/redi/esm/dispose.d.ts:2
disposed$Observable<string>--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:67

Methods

addRender()

addRender(unitId, renderer): void

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

Parameters

ParameterType
unitIdstring
rendererIRender

Returns

void


create()

create(unitId): void

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

Parameters

ParameterType
unitIdstring

Returns

void

Deprecated

this design is very very weird! Remove it.


createRender()

createRender(unitId): IRender

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

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

Parameters

ParameterType
unitIdstring

Returns

IRender

renderUnit:IRender


getAllRenderersOfType()

getAllRenderersOfType(type): RenderUnit[]

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

Parameters

ParameterType
typeUniverInstanceType

Returns

RenderUnit[]


getCurrent()

getCurrent(): Nullable<IRender>

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

Returns

Nullable<IRender>

Deprecated

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


getCurrentTypeOfRenderer()

getCurrentTypeOfRenderer(type): Nullable<RenderUnit>

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

Parameters

ParameterType
typeUniverInstanceType

Returns

Nullable<RenderUnit>


getFirst()

getFirst(): Nullable<IRender>

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

Returns

Nullable<IRender>

Deprecated

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


getRenderAll()

getRenderAll(): Map<string, IRender>

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

Returns

Map<string, IRender>


getRenderById()

getRenderById(unitId): Nullable<IRender>

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

get RenderUnit By Id, RenderUnit implements IRender

Parameters

ParameterType
unitIdstring

Returns

Nullable<IRender>


has()

has(unitId): boolean

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

Parameters

ParameterType
unitIdstring

Returns

boolean


registerRenderModule()

registerRenderModule<T>(type, dep): IDisposable

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

add dep to _renderDependencies(type, dep)

Type Parameters

Type Parameter
T extends UnitModel

Parameters

ParameterType
typenumber
depDependency<T>

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:44

Parameters

ParameterType
unitIdstring

Returns

void


setCurrent()

setCurrent(unitId): void

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

Parameters

ParameterType
unitIdstring

Returns

void


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:75

Type Parameters

Type Parameter
T

Parameters

ParameterType
typeUniverInstanceType
idDependencyIdentifier<T>

Returns

Nullable<T>