@univerjs/engine-render v0.5.0-beta.1 • Docs

Class: Slide

Extends

SceneViewer

Constructors

new Slide()

new Slide(key?, props?): Slide

Parameters

Parameter	Type
`key`?	`string`
`props`?	`IObjectFullState`

Returns

Slide

Inherited from

SceneViewer.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:33

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_dirty`	`protected`	`boolean`	`true`	`SceneViewer`.`_dirty`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:88
`_disposed`	`protected`	`boolean`	`false`	`SceneViewer`.`_disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
`_forceDirty`	`protected`	`boolean`	`true`	`SceneViewer`.`_forceDirty`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:89
`_oKey`	`protected`	`string`	`undefined`	`SceneViewer`.`_oKey`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:86
`groupKey?`	`public`	`string`	`undefined`	`SceneViewer`.`groupKey`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:59
`isInGroup`	`public`	`boolean`	`false`	`SceneViewer`.`isInGroup`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:60
`objectType`	`public`	`ObjectType`	`ObjectType.UNKNOWN`	`SceneViewer`.`objectType`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:62
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onDblclick$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:74
`onDispose$`	`public`	`EventSubject`<`BaseObject`>	`undefined`	`SceneViewer`.`onDispose$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:84
`onDragEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SceneViewer`.`onDragEnter$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:80
`onDragLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SceneViewer`.`onDragLeave$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:78
`onDragOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SceneViewer`.`onDragOver$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:79
`onDrop$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SceneViewer`.`onDrop$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:81
`onIsAddedToParent$`	`public`	`EventSubject`<`any`>	`undefined`	`SceneViewer`.`onIsAddedToParent$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:83
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	`SceneViewer`.`onMouseWheel$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:76
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerDown$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:66
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerEnter$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:72
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerLeave$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:71
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerMove$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:67
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerOut$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:69
`onPointerOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerOver$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:70
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onPointerUp$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:68
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	`SceneViewer`.`onTransformChange$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:64
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SceneViewer`.`onTripleClick$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:75
`slideChangePageByNavigation$`	`public`	`EventSubject`<`Nullable`<`string`>>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:38
`subSceneChanged$`	`public`	`EventSubject`<`Scene`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:40

Accessors

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

SceneViewer.ancestorGroup

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:251

ancestorLeft

Get Signature

get ancestorLeft(): any

Returns

any

Inherited from

SceneViewer.ancestorLeft

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:235

ancestorScaleX

Get Signature

get ancestorScaleX(): number

Returns

number

Inherited from

SceneViewer.ancestorScaleX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:225

ancestorScaleY

Get Signature

get ancestorScaleY(): number

Returns

number

Inherited from

SceneViewer.ancestorScaleY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:230

ancestorTop

Get Signature

get ancestorTop(): any

Returns

any

Inherited from

SceneViewer.ancestorTop

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:239

ancestorTransform

Get Signature

get ancestorTransform(): any

Returns

any

Inherited from

SceneViewer.ancestorTransform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:243

angle

Get Signature

get angle(): number

Returns

number

Set Signature

set angle(angle): void

Parameters

Parameter	Type
`angle`	`number`

Returns

void

Inherited from

SceneViewer.angle

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:213

classType

Get Signature

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

SceneViewer.classType

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:39

cursor

Get Signature

get cursor(): CURSOR_TYPE

Returns

CURSOR_TYPE

Set Signature

set cursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

SceneViewer.cursor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:303

debounceParentDirty

Get Signature

get debounceParentDirty(): boolean

Returns

boolean

Set Signature

set debounceParentDirty(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

SceneViewer.debounceParentDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:299

evented

Get Signature

get evented(): boolean

Returns

boolean

Set Signature

set evented(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

SceneViewer.evented

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:291

flipX

Get Signature

get flipX(): boolean

Returns

boolean

Set Signature

set flipX(flipX): void

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

void

Inherited from

SceneViewer.flipX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:271

flipY

Get Signature

get flipY(): boolean

Returns

boolean

Set Signature

set flipY(flipY): void

Parameters

Parameter	Type
`flipY`	`boolean`

Returns

void

Inherited from

SceneViewer.flipY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:275

height

Get Signature

get height(): number

Returns

number

Set Signature

set height(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SceneViewer.height

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:205

heightOrigin

Get Signature

get heightOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.heightOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:185

layer

Get Signature

get layer(): Nullable<Layer>

Returns

Nullable<Layer>

Set Signature

set layer(layer): void

Parameters

Parameter	Type
`layer`	`Layer`

Returns

void

Inherited from

SceneViewer.layer

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:307

left

Get Signature

get left(): number

Returns

number

Set Signature

set left(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SceneViewer.left

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:197

leftOrigin

Get Signature

get leftOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.leftOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:177

maxZIndex

Get Signature

get maxZIndex(): number

Returns

number

Inherited from

SceneViewer.maxZIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:399

oKey

Get Signature

get oKey(): string

Returns

string

Inherited from

SceneViewer.oKey

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:283

parent

Get Signature

get parent(): any

Returns

any

Set Signature

set parent(o): void

Parameters

Parameter	Type
`o`	`any`

Returns

void

Inherited from

SceneViewer.parent

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:279

printable

Get Signature

get printable(): boolean

Returns

boolean

Inherited from

SceneViewer.printable

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:169

scaleX

Get Signature

get scaleX(): number

Returns

number

Set Signature

set scaleX(scaleX): void

Parameters

Parameter	Type
`scaleX`	`number`

Returns

void

Inherited from

SceneViewer.scaleX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:217

scaleY

Get Signature

get scaleY(): number

Returns

number

Set Signature

set scaleY(scaleY): void

Parameters

Parameter	Type
`scaleY`	`number`

Returns

void

Inherited from

SceneViewer.scaleY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:221

skewX

Get Signature

get skewX(): number

Returns

number

Set Signature

set skewX(skewX): void

Parameters

Parameter	Type
`skewX`	`number`

Returns

void

Inherited from

SceneViewer.skewX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:263

skewY

Get Signature

get skewY(): number

Returns

number

Set Signature

set skewY(skewY): void

Parameters

Parameter	Type
`skewY`	`number`

Returns

void

Inherited from

SceneViewer.skewY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:267

strokeWidth

Get Signature

get strokeWidth(): number

Returns

number

Set Signature

set strokeWidth(width): void

Parameters

Parameter	Type
`width`	`number`

Returns

void

Inherited from

SceneViewer.strokeWidth

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:209

top

Get Signature

get top(): number

Returns

number

Set Signature

set top(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SceneViewer.top

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:193

topOrigin

Get Signature

get topOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.topOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:173

transform

Get Signature

get transform(): Transform

Returns

Transform

Set Signature

set transform(trans): void

Parameters

Parameter	Type
`trans`	`Transform`

Returns

void

Inherited from

SceneViewer.transform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:148

transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig

Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void

Parameters

Parameter	Type
`config`	`ITransformerConfig`

Returns

void

Inherited from

SceneViewer.transformerConfig

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:391

visible

Get Signature

get visible(): boolean

Returns

boolean

Inherited from

SceneViewer.visible

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:295

width

Get Signature

get width(): number

Returns

number

Set Signature

set width(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SceneViewer.width

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:201

widthOrigin

Get Signature

get widthOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.widthOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:181

zIndex

Get Signature

get zIndex(): number

Returns

number

Set Signature

set zIndex(index): void

Parameters

Parameter	Type
`index`	`number`

Returns

void

Inherited from

SceneViewer.zIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:287

Methods

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

SceneViewer._setTransForm

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:851

activeFirstPage()

activeFirstPage(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:44

activeSubScene()

activeSubScene(key): void

Parameters

Parameter	Type
`key`	`Nullable`<`string`>

Returns

void

Inherited from

SceneViewer.activeSubScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:104

addNavigation()

addNavigation(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:79

addPageScene()

addPageScene(pageScene): void

add pageScene to this._subScenes

Parameters

Parameter	Type
`pageScene`	`Scene`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:57

addSubScene()

addSubScene(scene): void

Parameters

Parameter	Type
`scene`	`Scene`

Returns

void

Inherited from

SceneViewer.addSubScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:89

allowSelectedClipElement()

allowSelectedClipElement(): boolean

Returns

boolean

Inherited from

SceneViewer.allowSelectedClipElement

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:123

applyTransform()

applyTransform(): void

Returns

void

Inherited from

SceneViewer.applyTransform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:839

changePage()

changePage(id?): void

Parameters

Parameter	Type
`id`?	`string`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:66

disableNav()

disableNav(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:140

disableSelectedClipElement()

disableSelectedClipElement(): void

Returns

void

Inherited from

SceneViewer.disableSelectedClipElement

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:119

dispose()

dispose(): void

Returns

void

Inherited from

SceneViewer.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:138

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

SceneViewer.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96

enableNav()

enableNav(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:136

enableSelectedClipElement()

enableSelectedClipElement(): void

Returns

void

Inherited from

SceneViewer.enableSelectedClipElement

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:115

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

SceneViewer.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100

flip()

flip(flipX?, flipY?): Slide

Parameters

Parameter	Type
`flipX`?	`boolean`
`flipY`?	`boolean`

Returns

Slide

Inherited from

SceneViewer.flip

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:522

getActiveSubScene()

getActiveSubScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

SceneViewer.getActiveSubScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:77

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

SceneViewer.getEngine

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:817

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Inherited from

SceneViewer.getInverseCoord

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:847

getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

SceneViewer.getLayerIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:832

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

SceneViewer.getObjects

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:828

getParent()

getParent(): any

Returns

any

Inherited from

SceneViewer.getParent

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:580

getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

SceneViewer.getScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:796

getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

SceneViewer.getState

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:584

getSubScene()

getSubScene(sceneKey): undefined | Scene

Parameters

Parameter	Type
`sceneKey`	`string`

Returns

undefined | Scene

Inherited from

SceneViewer.getSubScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:81

getSubScenes()

getSubScenes(): Map<string, Scene>

Returns

Map<string, Scene>

Inherited from

SceneViewer.getSubScenes

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:73

hasPage()

hasPage(key): undefined | Scene

Parameters

Parameter	Type
`key`	`string`

Returns

undefined | Scene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:75

hiddenNav()

hiddenNav(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:144

hide()

hide(): void

Returns

void

Inherited from

SceneViewer.hide

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:600

isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

SceneViewer.isDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:431

isHit()

isHit(coord): boolean

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Inherited from

SceneViewer.isHit

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:614

isRender()

isRender(bounds?): undefined | boolean

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

SceneViewer.isRender

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:573

makeDirty()

makeDirty(state): undefined | Slide

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

undefined | Slide

Inherited from

SceneViewer.makeDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:403

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Slide

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

Slide

Inherited from

SceneViewer.makeDirtyNoDebounce

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:422

makeForceDirty()

makeForceDirty(state): void

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

void

Inherited from

SceneViewer.makeForceDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:418

pick()

pick(coord): Nullable<BaseObject | Scene>

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Nullable<BaseObject | Scene>

Inherited from

SceneViewer.pick

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:128

removeNavigation()

removeNavigation(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:126

removeSubScene()

removeSubScene(key): void

Parameters

Parameter	Type
`key`	`string`

Returns

void

Inherited from

SceneViewer.removeSubScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:95

removeTransform()

removeTransform(): void

Returns

void

Inherited from

SceneViewer.removeTransform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:843

render()

render(mainCtx, bounds?): Slide

Parameters

Parameter	Type
`mainCtx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

Slide

Inherited from

SceneViewer.render

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene-viewer.ts:43

renderToThumb()

renderToThumb(
   mainCtx, 
   pageId, 
   scaleX, 
   scaleY): void

Parameters

Parameter	Type	Default value
`mainCtx`	`UniverRenderingContext`	`undefined`
`pageId`	`string`	`undefined`
`scaleX`	`number`	`1`
`scaleY`	`number`	`1`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:164

resetCursor()

resetCursor(): void

Returns

void

Inherited from

SceneViewer.resetCursor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:808

resize()

resize(width?, height?): Slide

Parameters

Parameter	Type
`width`?	`string` \| `number`
`height`?	`string` \| `number`

Returns

Slide

Inherited from

SceneViewer.resize

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:457

scale()

scale(scaleX?, scaleY?): Slide

Parameters

Parameter	Type
`scaleX`?	`number`
`scaleY`?	`number`

Returns

Slide

Inherited from

SceneViewer.scale

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:478

setCursor()

setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

SceneViewer.setCursor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:812

show()

show(): void

Returns

void

Inherited from

SceneViewer.show

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:605

showNav()

showNav(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/slides/slide.ts:154

skew()

skew(skewX?, skewY?): Slide

Parameters

Parameter	Type
`skewX`?	`number`
`skewY`?	`number`

Returns

Slide

Inherited from

SceneViewer.skew

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:500

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

SceneViewer.toJson

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:785

transformByState()

transformByState(option): undefined | Slide

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | Slide

Inherited from

SceneViewer.transformByState

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:547

transformForAngle()

transformForAngle(transform): Transform

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

SceneViewer.transformForAngle

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:153

translate()

translate(x?, y?): Slide

Parameters

Parameter	Type
`x`?	`string` \| `number`
`y`?	`string` \| `number`

Returns

Slide

Inherited from

SceneViewer.translate

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:435

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerDblclick

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:651

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SceneViewer.triggerDragEnter

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:737

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SceneViewer.triggerDragLeave

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:721

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SceneViewer.triggerDragOver

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:729

triggerDrop()

triggerDrop(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SceneViewer.triggerDrop

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:745

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

SceneViewer.triggerMouseWheel

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:671

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerDown

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:635

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerEnter

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:713

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerLeave

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:697

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerMove

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:627

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerOut

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:689

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerOver

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:705

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerPointerUp

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:643

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SceneViewer.triggerTripleClick

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:661

Skeleton Spreadsheet