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

Class: `abstract` ThinScene

Extends

Disposable

Constructors

new ThinScene()

new ThinScene(sceneKey): ThinScene

Parameters

Parameter	Type
`sceneKey`	`string`

Returns

ThinScene

Overrides

Disposable.constructor

Defined in

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

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
`debounceParentTimeout`	`public`	`number`	`-1`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:67
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:57
`onDragEnter$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:49
`onDragLeave$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:53
`onDragOver$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:51
`onDrop$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:55
`onFileLoaded$`	`public`	`EventSubject`<`string`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:33
`onKeyDown$`	`public`	`EventSubject`<`IKeyboardEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:63
`onKeyUp$`	`public`	`EventSubject`<`IKeyboardEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:65
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:61
`onPointerCancel$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:45
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:35
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:41
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:47
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:37
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:43
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:39
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:31
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:59

Accessors

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/thin-scene.ts:88

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/thin-scene.ts:100

objectsEvented

Get Signature

get objectsEvented(): boolean

Returns

boolean

Defined in

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

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/thin-scene.ts:104

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/thin-scene.ts:108

sceneKey

Get Signature

get sceneKey(): string

Returns

string

Defined in

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

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/thin-scene.ts:92

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/thin-scene.ts:96

Methods

addObject()

abstract addObject(o, zIndex?): void

Parameters

Parameter	Type
`o`	`BaseObject`
`zIndex`?	`number`

Returns

void

Defined in

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

addObjects()

abstract addObjects(objects, zIndex?): void

Parameters

Parameter	Type
`objects`	`BaseObject`[]
`zIndex`?	`number`

Returns

void

Defined in

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

addViewport()

abstract addViewport(...viewport): void

Parameters

Parameter	Type
…`viewport`	`any`[]

Returns

void

Defined in

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

attachTransformerTo()

attachTransformerTo(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

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

detachTransformerFrom()

detachTransformerFrom(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

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

disableObjectsEvent()

disableObjectsEvent(): void

If scene.event is disabled, scene.pick(curosrPos) 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/thin-scene.ts:149

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

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

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

enableObjectsEvent()

enableObjectsEvent(): void

Returns

void

Defined in

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

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

getAncestorScale()

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

Returns

{
  scaleX: 1;
  scaleY: 1;
}

Name	Type	Default value	Defined in
`scaleX`	`number`	1	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:256
`scaleY`	`number`	1	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:257

Defined in

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

getEngine()

abstract getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Defined in

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

getObject()

abstract 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/thin-scene.ts:222

getParent()

abstract getParent(): any

Returns

any

Defined in

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

getPrecisionScale()

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

Returns

{
  scaleX: 1;
  scaleY: 1;
}

Name	Type	Default value	Defined in
`scaleX`	`number`	1	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:263
`scaleY`	`number`	1	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/thin-scene.ts:264

Defined in

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

getViewports()

getViewports(): any[]

Returns

any[]

Defined in

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

makeDirty()

makeDirty(state): ThinScene

Parameters

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

Returns

ThinScene

Defined in

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

makeDirtyNoParent()

makeDirtyNoParent(state): ThinScene

Parameters

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

Returns

ThinScene

Defined in

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

pick()

abstract pick(coord): Nullable<BaseObject | ThinScene>

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Nullable<BaseObject | ThinScene>

Defined in

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

removeViewport()

abstract removeViewport(key): void

Parameters

Parameter	Type
`key`	`string`

Returns

void

Defined in

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

render()

abstract render(parentCtx?): void

Parameters

Parameter	Type
`parentCtx`?	`UniverRenderingContext`

Returns

void

Defined in

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

resetCursor()

abstract resetCursor(): void

Returns

void

Defined in

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

setCursor()

abstract setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Defined in

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

setObjectBehavior()

abstract setObjectBehavior(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

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

triggerDblclick()

abstract triggerDblclick(evt): void

Parameters

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

Returns

void

Defined in

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

triggerDragEnter()

abstract triggerDragEnter(evt): void

Parameters

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

Returns

void

Defined in

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

triggerDragLeave()

abstract triggerDragLeave(evt): void

Parameters

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

Returns

void

Defined in

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

triggerDragOver()

abstract triggerDragOver(evt): void

Parameters

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

Returns

void

Defined in

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

triggerDrop()

abstract triggerDrop(evt): void

Parameters

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

Returns

void

Defined in

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

triggerKeyDown()

triggerKeyDown(evt): void

Parameters

Parameter	Type
`evt`	`IKeyboardEvent`

Returns

void

Defined in

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

triggerKeyUp()

triggerKeyUp(evt): void

Parameters

Parameter	Type
`evt`	`IKeyboardEvent`

Returns

void

Defined in

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

triggerMouseWheel()

abstract triggerMouseWheel(evt): void

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

void

Defined in

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

triggerPointerDown()

abstract triggerPointerDown(evt): void

Parameters

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

Returns

void

Defined in

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

triggerPointerEnter()

abstract triggerPointerEnter(evt): void

Parameters

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

Returns

void

Defined in

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

triggerPointerLeave()

abstract triggerPointerLeave(evt): void

Parameters

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

Returns

void

Defined in

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

triggerPointerMove()

abstract triggerPointerMove(evt): void

Parameters

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

Returns

void

Defined in

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

triggerPointerOut()

abstract triggerPointerOut(evt): void

Parameters

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

Returns

void

Defined in

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

triggerPointerOver()

abstract triggerPointerOver(evt): void

Parameters

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

Returns

void

Defined in

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

triggerPointerUp()

abstract triggerPointerUp(evt): void

Parameters

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

Returns

void

Defined in

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

triggerTripleClick()

abstract triggerTripleClick(evt): void

Parameters

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

Returns

void

Defined in

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

Thinengine Transform

Class: abstract ThinScene

Extends

Constructors

new ThinScene()

Parameters

Returns

Overrides

Defined in

Properties

Accessors

classType

Get Signature

Returns

Defined in

height

Get Signature

Returns

Set Signature

Parameters

Returns

Defined in

objectsEvented

Get Signature

Returns

Defined in

scaleX

Get Signature

Returns

Set Signature

Parameters

Returns

Defined in

scaleY

Get Signature

Returns

Set Signature

Parameters

Returns

Defined in

sceneKey

Get Signature

Returns

Defined in

transform

Get Signature

Returns

Set Signature

Parameters

Returns

Defined in

width

Get Signature

Returns

Set Signature

Parameters

Returns

Defined in

Methods

addObject()

Parameters

Returns

Defined in

addObjects()

Parameters

Returns

Defined in

addViewport()

Parameters

Returns

Defined in

attachTransformerTo()

Parameters

Returns

Defined in

detachTransformerFrom()

Parameters

Returns

Defined in

disableObjectsEvent()

Returns

Class: `abstract` ThinScene