@univerjs/engine-render v0.1.17 • Docs
Class: RenderUnit
This class is responsible
Extends
Implements
Constructors
new RenderUnit()
new RenderUnit(parentInjector, init): RenderUnit
Parameters
Parameter | Type |
---|---|
parentInjector | Injector |
init | Pick <IRenderContext <UnitModel <object , number >>, "unit" | "scene" | "engine" | "isMainScene" > |
Returns
Overrides
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:70 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
isRenderUnit | readonly | true | undefined | - | submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:51 (opens in a new tab) |
Accessors
components
get components(): Map<string, RenderComponentType>
Returns
Map
<string
, RenderComponentType
>
Implementation of
IRender
.components
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:68 (opens in a new tab)
engine
get engine(): Engine
set engine(engine): void
Parameters
Parameter | Type |
---|---|
engine | Engine |
Returns
Implementation of
IRender
.engine
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:63 (opens in a new tab)
isMainScene
get isMainScene(): boolean
set isMainScene(is): void
Parameters
Parameter | Type |
---|---|
is | boolean |
Returns
boolean
Implementation of
IRender
.isMainScene
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:61 (opens in a new tab)
mainComponent
get mainComponent(): Nullable<RenderComponentType>
set mainComponent(component): void
Parameters
Parameter | Type |
---|---|
component | Nullable <RenderComponentType > |
Returns
Implementation of
IRender
.mainComponent
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:65 (opens in a new tab)
scene
get scene(): Scene
set scene(scene): void
Parameters
Parameter | Type |
---|---|
scene | Scene |
Returns
Implementation of
IRender
.scene
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:67 (opens in a new tab)
type
get type(): number
Returns
number
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:54 (opens in a new tab)
unitId
get unitId(): string
Returns
string
Implementation of
IRender
.unitId
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:53 (opens in a new tab)
Methods
addRenderControllers()
addRenderControllers(ctors): void
Parameters
Parameter | Type |
---|---|
ctors | IRenderModuleCtor <UnitModel <object , number >>[] |
Returns
void
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:103 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:90 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
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)
with()
with<T>(dependency): T
Get render controller hold by this render unit.
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
dependency | DependencyIdentifier <T > |
Returns
T
Implementation of
Defined in
submodules/univer/packages/engine-render/src/render-manager/render-unit.ts:99 (opens in a new tab)