API Reference
@univerjs
@univerjs/engine-render
interfaces
Irendermanagerservice

@univerjs/engine-render v0.4.2Docs


Interface: IRenderManagerService

Extends

Properties

PropertyTypeDescriptionDefined in
createRender$Observable<string>Deprecatedsubmodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:62 (opens in a new tab)
created$Observable<IRender>-submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:66 (opens in a new tab)
currentRender$Observable<Nullable<string>>Deprecatedsubmodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:34 (opens in a new tab)
defaultEngineEngine-submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:54 (opens in a new tab)
disposed$Observable<string>-submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:67 (opens in a new tab)

Methods

addRender()

addRender(unitId, renderer): void

Parameters

ParameterType
unitIdstring
rendererIRender

Returns

void

Defined in

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


create()

create(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Deprecated

this design is very very weird! Remove it.

Defined in

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


createRender()

createRender(unitId): IRender

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

Parameters

ParameterType
unitIdstring

Returns

IRender

renderUnit:IRender

Defined in

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


dispose()

dispose(): void

Returns

void

Inherited from

IDisposable.dispose

Defined in

submodules/univer/node_modules/.pnpm/@wendellhu+redi@0.16.1/node_modules/@wendellhu/redi/esm/dispose.d.ts:2


getAllRenderersOfType()

getAllRenderersOfType(type): RenderUnit[]

Parameters

ParameterType
typeUniverInstanceType

Returns

RenderUnit[]

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:51 (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.

Defined in

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


getCurrentTypeOfRenderer()

getCurrentTypeOfRenderer(type): Nullable<RenderUnit>

Parameters

ParameterType
typeUniverInstanceType

Returns

Nullable<RenderUnit>

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:52 (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.

Defined in

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


getRenderAll()

getRenderAll(): Map<string, IRender>

Returns

Map<string, IRender>

Defined in

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


getRenderById()

getRenderById(unitId): Nullable<IRender>

get RenderUnit By Id, RenderUnit implements IRender

Parameters

ParameterType
unitIdstring

Returns

Nullable<IRender>

Defined in

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


has()

has(unitId): boolean

Parameters

ParameterType
unitIdstring

Returns

boolean

Defined in

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


registerRenderModule()

registerRenderModule<T>(type, dep): IDisposable

add dep to _renderDependencies(type, dep)

Type Parameters

Type Parameter
T extends UnitModel<object, number>

Parameters

ParameterType
typenumber
depDependency<T>

Returns

IDisposable

Defined in

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


removeRender()

removeRender(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

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


setCurrent()

setCurrent(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:45 (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>

Defined in

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


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