@univerjs/slides-ui v0.4.2 • Docs
Class: CanvasView
Every render module should implement this interface.
Extends
Implements
Constructors
new CanvasView()
new CanvasView(_renderManagerService): CanvasView
Parameters
Parameter | Type |
---|---|
_renderManagerService | IRenderManagerService |
Returns
Overrides
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:31 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | RxDisposable ._disposed | packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
dispose$ | protected | Subject <void > | undefined | RxDisposable .dispose$ | packages/core/src/shared/lifecycle.ts:117 (opens in a new tab) |
Methods
activePage()
activePage(pageId, unitId): void
Parameters
Parameter | Type |
---|---|
pageId | string |
unitId | string |
Returns
void
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:52 (opens in a new tab)
appendPage()
appendPage(unitId): void
append blank page
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:80 (opens in a new tab)
createObjectToPage()
createObjectToPage(
element,
pageID,
unitId): Nullable<BaseObject>
Parameters
Parameter | Type |
---|---|
element | IPageElement |
pageID | string |
unitId | string |
Returns
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:62 (opens in a new tab)
createThumbs()
createThumbs(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:47 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Implementation of
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:119 (opens in a new tab)
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
RxDisposable
.ensureNotDisposed
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getRenderUnitByPageId()
getRenderUnitByPageId(pageId, unitId): {
engine: Engine;
scene: pageScene;
unit: UnitModel<object, number>;
}
Parameters
Parameter | Type |
---|---|
pageId | string |
unitId | string |
Returns
{
engine: Engine;
scene: pageScene;
unit: UnitModel<object, number>;
}
Name | Type | Default value | Defined in |
---|---|---|---|
engine | Engine | - | packages/slides-ui/src/controllers/slide.render-controller.ts:418 (opens in a new tab) |
scene | Scene | pageScene | packages/slides-ui/src/controllers/slide.render-controller.ts:417 (opens in a new tab) |
unit | UnitModel <object , number > | - | packages/slides-ui/src/controllers/slide.render-controller.ts:419 (opens in a new tab) |
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:57 (opens in a new tab)
removeObjectById()
removeObjectById(
id,
pageID,
unitId): void
Parameters
Parameter | Type |
---|---|
id | string |
pageID | string |
unitId | string |
Returns
void
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:72 (opens in a new tab)
setObjectActiveByPage()
setObjectActiveByPage(
obj,
pageID,
unitId): void
Parameters
Parameter | Type |
---|---|
obj | BaseObject |
pageID | string |
unitId | string |
Returns
void
Defined in
packages/slides-ui/src/controllers/canvas-view.ts:67 (opens in a new tab)