@univerjs/engine-render v0.4.2 • Docs
Class: RenderManagerService
Extends
Implements
Constructors
new RenderManagerService()
new RenderManagerService(_injector, _univerInstanceService): RenderManagerService
Parameters
Parameter | Type |
---|---|
_injector | Injector |
_univerInstanceService | IUniverInstanceService |
Returns
Overrides
Defined in
Properties
Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
---|---|---|---|---|---|---|
_disposed | protected | boolean | false | - | Disposable ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
createRender$ | readonly | Observable <string > | undefined | Deprecated | - | submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:101 (opens in a new tab) |
created$ | readonly | Observable <IRender > | undefined | - | - | submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:104 (opens in a new tab) |
currentRender$ | readonly | Observable <Nullable <string >> | undefined | Deprecated | - | submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:97 (opens in a new tab) |
disposed$ | readonly | Observable <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
Implementation of
IRenderManagerService
.defaultEngine
Defined in
Methods
_createRender()
protected _createRender(
unitId,
engine,
isMainScene): IRender
create renderUnit & init deps from renderDependencies by renderUnit's type
Parameters
Parameter | Type | Default value |
---|---|---|
unitId | string | undefined |
engine | Engine | undefined |
isMainScene | boolean | true |
Returns
renderUnit:IRender
Defined in
addRender()
addRender(unitId, renderUnit): void
Parameters
Parameter | Type |
---|---|
unitId | string |
renderUnit | IRender |
Returns
void
Implementation of
IRenderManagerService
.addRender
Defined in
create()
create(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Deprecated
this design is very very weird! Remove it.
Implementation of
Defined in
createRender()
createRender(unitId): IRender
create renderUnit & init deps from renderDependencies
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
renderUnit:IRender
Implementation of
IRenderManagerService
.createRender
Defined in
dispose()
dispose(): void
Returns
void
Implementation of
Overrides
Defined in
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getAllRenderersOfType()
getAllRenderersOfType(type): RenderUnit[]
Parameters
Parameter | Type |
---|---|
type | UniverInstanceType |
Returns
Implementation of
IRenderManagerService
.getAllRenderersOfType
Defined in
getCurrent()
getCurrent(): Nullable<IRender>
Returns
Deprecated
There will be multi units to render at the same time, so there is no current.
Implementation of
IRenderManagerService
.getCurrent
Defined in
getCurrentTypeOfRenderer()
getCurrentTypeOfRenderer(type): Nullable<RenderUnit>
Parameters
Parameter | Type |
---|---|
type | UniverInstanceType |
Returns
Implementation of
IRenderManagerService
.getCurrentTypeOfRenderer
Defined in
getFirst()
getFirst(): Nullable<IRender>
Returns
Deprecated
There will be multi units to render at the same time, so there is no first.
Implementation of
IRenderManagerService
.getFirst
Defined in
getRenderAll()
getRenderAll(): Map<string, IRender>
Returns
Map
<string
, IRender
>
Implementation of
IRenderManagerService
.getRenderAll
Defined in
getRenderById()
getRenderById(unitId): Nullable<IRender>
get RenderUnit from this._renderMap
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
RenderUnit, aka IRender
Implementation of
IRenderManagerService
.getRenderById
Defined in
has()
has(unitId): boolean
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
boolean
Implementation of
Defined in
registerRenderModule()
registerRenderModule(type, depCtor): IDisposable
add dep to _renderDependencies(type, dep)
Parameters
Parameter | Type |
---|---|
type | number |
depCtor | Dependency |
Returns
Implementation of
IRenderManagerService
.registerRenderModule
Defined in
registerRenderModules()
registerRenderModules(type, deps): IDisposable
Parameters
Parameter | Type |
---|---|
type | number |
deps | Dependency [] |
Returns
Defined in
removeRender()
removeRender(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Implementation of
IRenderManagerService
.removeRender
Defined in
setCurrent()
setCurrent(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Implementation of
IRenderManagerService
.setCurrent
Defined in
withCurrentTypeOfUnit()
withCurrentTypeOfUnit<T>(type, id): Nullable<T>
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
type | UniverInstanceType |
id | DependencyIdentifier <T > |
Returns
Nullable
<T
>
Implementation of
IRenderManagerService
.withCurrentTypeOfUnit