@univerjsslides-uiclassesCanvasview

@univerjs/slides-ui v0.5.4


Class: CanvasView

Defined in: submodules/univer/packages/slides-ui/src/controllers/canvas-view.ts:30

Every render module should implement this interface.

Extends

Implements

Constructors

new CanvasView()

new CanvasView(_renderManagerService): CanvasView

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

Parameters

ParameterType
_renderManagerServiceIRenderManagerService

Returns

CanvasView

Overrides

RxDisposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseRxDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96
dispose$protectedSubject<void>undefinedRxDisposable.dispose$submodules/univer/packages/core/src/shared/lifecycle.ts:120

Methods

activePage()

activePage(pageId, unitId): void

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

Parameters

ParameterType
pageIdstring
unitIdstring

Returns

void


appendPage()

appendPage(unitId): void

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

append blank page

Parameters

ParameterType
unitIdstring

Returns

void


createObjectToPage()

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

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

Parameters

ParameterType
elementIPageElement
pageIDstring
unitIdstring

Returns

Nullable<BaseObject>


createThumbs()

createThumbs(unitId): void

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

Parameters

ParameterType
unitIdstring

Returns

void


dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:122

Returns

void

Implementation of

IRenderModule.dispose

Inherited from

RxDisposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

RxDisposable.ensureNotDisposed


getRenderUnitByPageId()

getRenderUnitByPageId(pageId, unitId): {
  engine: Engine;
  scene: Scene;
  unit: UnitModel;
}

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

Parameters

ParameterType
pageIdstring
unitIdstring

Returns

{
  engine: Engine;
  scene: Scene;
  unit: UnitModel;
}
NameTypeDefault valueDefined in
engineEngine-submodules/univer/packages/slides-ui/src/controllers/slide.render-controller.ts:418
sceneScenepageScenesubmodules/univer/packages/slides-ui/src/controllers/slide.render-controller.ts:417
unitUnitModel-submodules/univer/packages/slides-ui/src/controllers/slide.render-controller.ts:419

removeObjectById()

removeObjectById(
   id, 
   pageID, 
   unitId): void

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

Parameters

ParameterType
idstring
pageIDstring
unitIdstring

Returns

void


setObjectActiveByPage()

setObjectActiveByPage(
   obj, 
   pageID, 
   unitId): void

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

Parameters

ParameterType
objBaseObject
pageIDstring
unitIdstring

Returns

void