@univerjs/engine-render v0.4.2 • Docs
Interface: IRenderManagerService
Extends
Properties
Property | Type | Description | Defined in |
---|---|---|---|
createRender$ | Observable <string > | Deprecated | submodules/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 >> | Deprecated | submodules/univer/packages/engine-render/src/render-manager/render-manager.service.ts:34 (opens in a new tab) |
defaultEngine | Engine | - | 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
Parameter | Type |
---|---|
unitId | string |
renderer | IRender |
Returns
void
Defined in
create()
create(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Deprecated
this design is very very weird! Remove it.
Defined in
createRender()
createRender(unitId): IRender
create renderUnit & init deps from renderDependencies by renderUnit's type.
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
renderUnit:IRender
Defined in
dispose()
dispose(): void
Returns
void
Inherited from
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
Parameter | Type |
---|---|
type | UniverInstanceType |
Returns
Defined in
getCurrent()
getCurrent(): Nullable<IRender>
Returns
Deprecated
There will be multi units to render at the same time, so there is no current.
Defined in
getCurrentTypeOfRenderer()
getCurrentTypeOfRenderer(type): Nullable<RenderUnit>
Parameters
Parameter | Type |
---|---|
type | UniverInstanceType |
Returns
Defined in
getFirst()
getFirst(): Nullable<IRender>
Returns
Deprecated
There will be multi units to render at the same time, so there is no first.
Defined in
getRenderAll()
getRenderAll(): Map<string, IRender>
Returns
Map
<string
, IRender
>
Defined in
getRenderById()
getRenderById(unitId): Nullable<IRender>
get RenderUnit By Id, RenderUnit implements IRender
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Defined in
has()
has(unitId): boolean
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
boolean
Defined in
registerRenderModule()
registerRenderModule<T>(type, dep): IDisposable
add dep to _renderDependencies(type, dep)
Type Parameters
Type Parameter |
---|
T extends UnitModel <object , number > |
Parameters
Parameter | Type |
---|---|
type | number |
dep | Dependency <T > |
Returns
Defined in
removeRender()
removeRender(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
setCurrent()
setCurrent(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
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
>