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

Class: Scene

Extends

Disposable

Constructors

new Scene()

new Scene(
   sceneKey, 
   _parent, 
   state?): Scene

Parameters

Parameter	Type
`sceneKey`	`string`
`_parent`	`Engine` \| `SceneViewer`
`state`?	`ISceneTransformState`

Returns

Scene

Overrides

Disposable.constructor

Defined in

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

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
`addObject$`	`readonly`	`Observable`<`Scene`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:64
`afterRender$`	`readonly`	`Observable`<`Nullable`<`Canvas`>>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:88
`beforeRender$`	`readonly`	`Observable`<`Nullable`<`Canvas`>>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:86
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:79
`onDragEnter$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:75
`onDragLeave$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:77
`onDragOver$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:76
`onDrop$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:78
`onFileLoaded$`	`public`	`EventSubject`<`string`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:67
`onKeyDown$`	`public`	`EventSubject`<`IKeyboardEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:82
`onKeyUp$`	`public`	`EventSubject`<`IKeyboardEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:83
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:81
`onPointerCancel$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:73
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:68
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:71
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:74
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:69
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:72
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:70
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:66
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:80

Accessors

ancestorLeft

Get Signature

get ancestorLeft(): number

Returns

number

Defined in

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

ancestorScaleX

Get Signature

get ancestorScaleX(): number

Returns

number

Defined in

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

ancestorScaleY

Get Signature

get ancestorScaleY(): number

Returns

number

Defined in

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

ancestorTop

Get Signature

get ancestorTop(): number

Returns

number

Defined in

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

classType

Get Signature

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Defined in

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

cursor

Set Signature

set cursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Defined in

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

height

Get Signature

get height(): number

Returns

number

Set Signature

set height(num): void

Parameters

Parameter	Type
`num`	`number`

Returns

void

Defined in

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

objectsEvented

Get Signature

get objectsEvented(): boolean

Returns

boolean

Defined in

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

scaleX

Get Signature

get scaleX(): number

Returns

number

Set Signature

set scaleX(scaleX): void

Parameters

Parameter	Type
`scaleX`	`number`

Returns

void

Defined in

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

scaleY

Get Signature

get scaleY(): number

Returns

number

Set Signature

set scaleY(scaleY): void

Parameters

Parameter	Type
`scaleY`	`number`

Returns

void

Defined in

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

sceneKey

Get Signature

get sceneKey(): string

Returns

string

Defined in

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

transform

Get Signature

get transform(): Transform

Returns

Transform

Set Signature

set transform(trans): void

Parameters

Parameter	Type
`trans`	`Transform`

Returns

void

Defined in

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

width

Get Signature

get width(): number

Returns

number

Set Signature

set width(num): void

Parameters

Parameter	Type
`num`	`number`

Returns

void

Defined in

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

Methods

addLayer()

addLayer(...argument): void

Parameters

Parameter	Type
…`argument`	`Layer`[]

Returns

void

Defined in

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

addObject()

addObject(o, zIndex): Scene

Add object to Layer (Layer is specified by zIndex). If object is a group, insert all its children and group itself to _objects[].

Parameters

Parameter	Type	Default value	Description
`o`	`BaseObject`	`undefined`	-
`zIndex`	`number`	`1`	layer index

Returns

Scene

scene

Defined in

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

addObjects()

addObjects(objects, zIndex): Scene

Add objects to Layer( Layer is specfied by zIndex) If object is a group, insert all its children and group itself to _objects[].

Parameters

Parameter	Type	Default value
`objects`	`BaseObject`[]	`undefined`
`zIndex`	`number`	`1`

Returns

Scene

this

Defined in

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

addViewport()

addViewport(...viewport): Scene

Parameters

Parameter	Type
…`viewport`	`Viewport`[]

Returns

Scene

Defined in

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

attachControl()

attachControl(options?): undefined | Scene

Parameters

Parameter	Type
`options`?	`ISceneInputControlOptions`

Returns

undefined | Scene

Defined in

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

attachTransformerTo()

attachTransformerTo(o): void

create transformer if not exist, and then transformer attach to object that passed in by parameter.

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

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

clearLayer()

clearLayer(): void

Returns

void

Defined in

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

clearViewports()

clearViewports(): void

Returns

void

Defined in

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

detachControl()

detachControl(): Scene

Returns

Scene

Defined in

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

detachTransformerFrom()

detachTransformerFrom(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

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

disableLayerCache()

disableLayerCache(...layerIndexes): void

Parameters

Parameter	Type
…`layerIndexes`	`number`[]

Returns

void

Defined in

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

disableObjectsEvent()

disableObjectsEvent(): void

If scene.event is disabled, scene.pick(cursor Pos) return null. Then only scene itself can response to pointer event, all objects under the scene would not. see sceneInputManager@_onPointerMove

Returns

void

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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

enableLayerCache()

enableLayerCache(...layerIndexes): void

Parameters

Parameter	Type
…`layerIndexes`	`number`[]

Returns

void

Defined in

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

enableObjectsEvent()

enableObjectsEvent(): void

Returns

void

Defined in

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

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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

findLayerByZIndex()

findLayerByZIndex(zIndex): Nullable<Layer>

Parameters

Parameter	Type	Default value
`zIndex`	`number`	`1`

Returns

Nullable<Layer>

Defined in

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

findViewportByPosToScene()

findViewportByPosToScene(coord): undefined | Viewport

Get viewport by cursor position. Position is relative to canvas(event offsetXY).

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

undefined | Viewport

Defined in

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

fuzzyMathObjects()

fuzzyMathObjects(oKey, matchStart): BaseObject[]

Parameters

Parameter	Type	Default value
`oKey`	`string`	`undefined`
`matchStart`	`boolean`	`false`

Returns

BaseObject[]

Defined in

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

getActiveViewportByCoord()

getActiveViewportByCoord(coord): undefined | Viewport

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

undefined | Viewport

Defined in

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

getAllObjects()

getAllObjects(): BaseObject[]

Get all objects of each Layer.

Returns

BaseObject[]

objects

Defined in

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

getAllObjectsByDescOrder()

getAllObjectsByDescOrder(isDesc): BaseObject[]

get objects which is visible and not in a group.

Parameters

Parameter	Type	Default value
`isDesc`	`boolean`	`false`

Returns

BaseObject[]

BaseObject[]

Defined in

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

getAllObjectsByOrder()

getAllObjectsByOrder(): BaseObject[]

Get objects which is visible and not in a group in each layer.

Returns

BaseObject[]

BaseObject[]

Defined in

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

getAllObjectsByOrderForPick()

getAllObjectsByOrderForPick(isDesc): BaseObject[]

Get visible and evented objects.

Parameters

Parameter	Type	Default value
`isDesc`	`boolean`	`false`

Returns

BaseObject[]

objects

Defined in

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

getAncestorScale()

getAncestorScale(): {
  scaleX: number;
  scaleY: number;
}

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:875
`scaleY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:876

Defined in

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

getCoordRelativeToViewport()

getCoordRelativeToViewport(coord): Vector2

Get coord to active viewport. In a nested scene scenario, it is necessary to obtain the relative offsets layer by layer.

origin name: getRelativeToViewportCoord

Parameters

Parameter	Type	Description
`coord`	`Vector2`	Coordinates to be converted.

Returns

Vector2

Defined in

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

getCursor()

getCursor(): CURSOR_TYPE

Returns

CURSOR_TYPE

Defined in

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

getDefaultViewport()

getDefaultViewport(): Viewport

Returns

Viewport

Defined in

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

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Defined in

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

getLayer()

getLayer(zIndex): Layer

Parameters

Parameter	Type	Default value
`zIndex`	`number`	`1`

Returns

Layer

Defined in

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

getLayerMaxZIndex()

getLayerMaxZIndex(): number

Returns

number

Defined in

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

getLayers()

getLayers(): Layer[]

Returns

Layer[]

Defined in

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

getMainViewport()

getMainViewport(): Viewport

Returns

Viewport

Defined in

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

getObject()

getObject(oKey): Nullable<BaseObject>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<BaseObject>

Defined in

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

getObjectIncludeInGroup()

getObjectIncludeInGroup(oKey): Nullable<BaseObject>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<BaseObject>

Defined in

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

getObjectsByLayer()

getObjectsByLayer(zIndex): BaseObject[]

Parameters

Parameter	Type
`zIndex`	`number`

Returns

BaseObject[]

Defined in

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

getParent()

getParent(): Engine | SceneViewer

Returns

Engine | SceneViewer

Defined in

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

getPrecisionScale()

getPrecisionScale(): {
  scaleX: number;
  scaleY: number;
}

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:885
`scaleY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:886

Defined in

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

getRelativeToViewportCoord()

getRelativeToViewportCoord(coord): Vector2

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Deprecated

use getCoordRelativeToViewport instead

Defined in

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

getScrollXYInfoByViewport()

getScrollXYInfoByViewport(pos, viewPort?): {
  x: number;
  y: number;
}

getViewportScrollXYInfo by viewport under cursor position prev getScrollXYByRelativeCoords

Parameters

Parameter	Type
`pos`	`Vector2`
`viewPort`?	`Viewport`

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
`x`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:798
`y`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:799

Defined in

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

getTransformer()

getTransformer(): Nullable<Transformer>

Returns

Nullable<Transformer>

Defined in

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

getTransformerByCreate()

getTransformerByCreate(): Transformer

Returns

Transformer

Defined in

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

getViewport()

getViewport(key): undefined | Viewport

Parameters

Parameter	Type
`key`	`string`

Returns

undefined | Viewport

Defined in

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

getViewports()

getViewports(): Viewport[]

Returns

Viewport[]

Defined in

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

getViewportScrollXY()

getViewportScrollXY(viewPort): {
  x: number;
  y: number;
}

Parameters

Parameter	Type
`viewPort`	`Viewport`

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
`x`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:798
`y`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:799

Defined in

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

getVpScrollXYInfoByPosToVp()

getVpScrollXYInfoByPosToVp(pos, viewPort?): {
  x: number;
  y: number;
}

Parameters

Parameter	Type
`pos`	`Vector2`
`viewPort`?	`Viewport`

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
`x`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:798
`y`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:799

Deprecated

use getScrollXYInfoByViewport instead.

Defined in

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

initTransformer()

initTransformer(config?): void

Parameters

Parameter	Type
`config`?	`ITransformerConfig`

Returns

void

Defined in

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

isDirty()

isDirty(): boolean

Returns

boolean

Defined in

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

makeDirty()

makeDirty(state): Scene

Parameters

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

Returns

Scene

Defined in

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

makeDirtyNoParent()

makeDirtyNoParent(state): Scene

Parameters

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

Returns

Scene

Defined in

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

pick()

pick(coord): Nullable<BaseObject | Scene>

Get the object under the pointer, if scene.event is disabled, the object is null.

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Nullable<BaseObject | Scene>

object under the pointer

Defined in

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

removeObject()

removeObject(object?): Nullable<Scene>

Parameters

Parameter	Type
`object`?	`string` \| `BaseObject`

Returns

Nullable<Scene>

Defined in

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

removeObjects()

removeObjects(objects?): Nullable<Scene>

Parameters

Parameter	Type
`objects`?	`string`[] \| `BaseObject`[]

Returns

Nullable<Scene>

Defined in

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

removeViewport()

removeViewport(key): undefined | Viewport

Parameters

Parameter	Type
`key`	`string`

Returns

undefined | Viewport

Defined in

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

render()

render(parentCtx?): void

Parameters

Parameter	Type
`parentCtx`?	`UniverRenderingContext`

Returns

void

Defined in

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

requestRender()

requestRender(parentCtx?): Promise<unknown>

Parameters

Parameter	Type
`parentCtx`?	`UniverRenderingContext`

Returns

Promise<unknown>

Defined in

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

resetCursor()

resetCursor(): void

Returns

void

Defined in

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

resize()

resize(width?, height?): Scene

Parameters

Parameter	Type
`width`?	`number`
`height`?	`number`

Returns

Scene

Defined in

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

scale()

scale(scaleX?, scaleY?): Scene

Set scale, and then emit event to update Viewport scroll state.

Parameters

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

Returns

Scene

Scene

Defined in

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

scaleBy()

scaleBy(scaleX?, scaleY?): Scene

current scale plus offset, relative

Parameters

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

Returns

Scene

Defined in

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

setCursor()

setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Defined in

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

setDefaultCursor()

setDefaultCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Defined in

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

setObjectBehavior()

setObjectBehavior(o): void

Set Scene as object parent, if object has no parent.

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

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

setScaleValue()

setScaleValue(scaleX, scaleY): void

Parameters

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

Returns

void

Defined in

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

transformByState()

transformByState(state): void

Reset canvas size and update scroll

Parameters

Parameter	Type
`state`	`ISceneTransformState`

Returns

void

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IDragEvent`

Returns

boolean

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IDragEvent`

Returns

boolean

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IDragEvent`

Returns

boolean

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

Parameter	Type
`evt`	`IDragEvent`

Returns

boolean

Defined in

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

triggerKeyDown()

triggerKeyDown(evt): void

Parameters

Parameter	Type
`evt`	`IKeyboardEvent`

Returns

void

Defined in

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

triggerKeyUp()

triggerKeyUp(evt): void

Parameters

Parameter	Type
`evt`	`IKeyboardEvent`

Returns

void

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

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

Returns

boolean

Defined in

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

updateTransformerZero()

updateTransformerZero(left, top): void

Parameters

Parameter	Type
`left`	`number`
`top`	`number`

Returns

void

Defined in

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

Rowheaderlayout Scenecanvas