API Reference
@univerjs
@univerjs/slides-ui
classes
Canvasview

@univerjs/slides-ui v0.2.14Docs


Class: CanvasView

Every render module should implement this interface.

Extends

Implements

Constructors

new CanvasView()

new CanvasView(_renderManagerService): CanvasView

Parameters

ParameterType
_renderManagerServiceIRenderManagerService

Returns

CanvasView

Overrides

RxDisposable.constructor

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:33 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseRxDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
dispose$protectedSubject<void>undefinedRxDisposable.dispose$packages/core/src/shared/lifecycle.ts:117 (opens in a new tab)

Methods

activePage()

activePage(pageId, unitId): void

Parameters

ParameterType
pageIdstring
unitIdstring

Returns

void

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:54 (opens in a new tab)


appendPage()

appendPage(unitId): void

append blank page

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:82 (opens in a new tab)


createObjectToPage()

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

Parameters

ParameterType
elementIPageElement
pageIDstring
unitIdstring

Returns

Nullable<BaseObject>

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:64 (opens in a new tab)


createThumbs()

createThumbs(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:49 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Implementation of

IRenderModule.dispose

Inherited from

RxDisposable.dispose

Defined in

packages/core/src/shared/lifecycle.ts:119 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

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

ParameterType
pageIdstring
unitIdstring

Returns

{
  engine: Engine;
  scene: pageScene;
  unit: UnitModel<object, number>;
}
NameTypeDefault valueDefined in
engineEngine-packages/slides-ui/src/controllers/slide.render-controller.ts:418 (opens in a new tab)
sceneScenepageScenepackages/slides-ui/src/controllers/slide.render-controller.ts:417 (opens in a new tab)
unitUnitModel<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:59 (opens in a new tab)


removeObjectById()

removeObjectById(
   id, 
   pageID, 
   unitId): void

Parameters

ParameterType
idstring
pageIDstring
unitIdstring

Returns

void

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:74 (opens in a new tab)


setObjectActiveByPage()

setObjectActiveByPage(
   obj, 
   pageID, 
   unitId): void

Parameters

ParameterType
objBaseObject
pageIDstring
unitIdstring

Returns

void

Defined in

packages/slides-ui/src/controllers/canvas-view.ts:69 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.