@univerjs/slides-ui v0.5.0-beta.1 • Docs

Class: CanvasView

Every render module should implement this interface.

Extends

RxDisposable

Implements

IRenderModule

Constructors

new CanvasView()

new CanvasView(_renderManagerService): CanvasView

Parameters

Parameter	Type
`_renderManagerService`	`IRenderManagerService`

Returns

CanvasView

Overrides

RxDisposable.constructor

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:31

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`RxDisposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93
`dispose$`	`protected`	`Subject`<`void`>	`undefined`	`RxDisposable`.`dispose$`	submodules/univer/packages/core/src/shared/lifecycle.ts:117

Methods

activePage()

activePage(pageId, unitId): void

Parameters

Parameter	Type
`pageId`	`string`
`unitId`	`string`

Returns

void

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:52

appendPage()

appendPage(unitId): void

append blank page

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:80

createObjectToPage()

createObjectToPage(
   element, 
   pageID, 
unitId): Nullable<BaseObject>

Parameters

Parameter	Type
`element`	`IPageElement`
`pageID`	`string`
`unitId`	`string`

Returns

Nullable<BaseObject>

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:62

createThumbs()

createThumbs(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:47

dispose()

dispose(): void

Returns

void

Implementation of

IRenderModule.dispose

Inherited from

RxDisposable.dispose

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:119

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

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`	-	submodules/univer/packages/slides-ui/src/controllers/slide.render-controller.ts:418
`scene`	`Scene`	pageScene	submodules/univer/packages/slides-ui/src/controllers/slide.render-controller.ts:417
`unit`	`UnitModel`<`object`, `number`>	-	submodules/univer/packages/slides-ui/src/controllers/slide.render-controller.ts:419

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:57

removeObjectById()

removeObjectById(
   id, 
   pageID, 
   unitId): void

Parameters

Parameter	Type
`id`	`string`
`pageID`	`string`
`unitId`	`string`

Returns

void

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:72

setObjectActiveByPage()

setObjectActiveByPage(
   obj, 
   pageID, 
   unitId): void

Parameters

Parameter	Type
`obj`	`BaseObject`
`pageID`	`string`
`unitId`	`string`

Returns

void

Defined in

submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:67

Readme Slidecanvaspopmangerservice