@univerjs/engine-render v0.1.17 • Docs

Class: Slide

Extends

• SceneViewer

Constructors

new Slide()

new Slide(key?, props?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.constructor

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:33 (opens in a new tab)

Properties

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

SceneViewer.ancestorGroup

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:237 (opens in a new tab)

ancestorLeft

get ancestorLeft(): any

Returns

any

Inherited from

SceneViewer.ancestorLeft

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:221 (opens in a new tab)

ancestorScaleX

get ancestorScaleX(): number

Returns

number

Inherited from

SceneViewer.ancestorScaleX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:211 (opens in a new tab)

ancestorScaleY

get ancestorScaleY(): number

Returns

number

Inherited from

SceneViewer.ancestorScaleY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:216 (opens in a new tab)

ancestorTop

get ancestorTop(): any

Returns

any

Inherited from

SceneViewer.ancestorTop

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:225 (opens in a new tab)

ancestorTransform

get ancestorTransform(): any

Returns

any

Inherited from

SceneViewer.ancestorTransform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:229 (opens in a new tab)

angle

get angle(): number

set angle(angle): void

Parameters

Returns

number

Inherited from

SceneViewer.angle

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:199 (opens in a new tab)

classType

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

SceneViewer.classType

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:39 (opens in a new tab)

cursor

get cursor(): CURSOR_TYPE

set cursor(val): void

Parameters

Returns

CURSOR_TYPE

Inherited from

SceneViewer.cursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:289 (opens in a new tab)

debounceParentDirty

get debounceParentDirty(): boolean

set debounceParentDirty(state): void

Parameters

Returns

boolean

Inherited from

SceneViewer.debounceParentDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:285 (opens in a new tab)

evented

get evented(): boolean

set evented(state): void

Parameters

Returns

boolean

Inherited from

SceneViewer.evented

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:277 (opens in a new tab)

flipX

get flipX(): boolean

set flipX(flipX): void

Parameters

Returns

boolean

Inherited from

SceneViewer.flipX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:257 (opens in a new tab)

flipY

get flipY(): boolean

set flipY(flipY): void

Parameters

Returns

boolean

Inherited from

SceneViewer.flipY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:261 (opens in a new tab)

height

get height(): number

set height(num): void

Parameters

Returns

number

Inherited from

SceneViewer.height

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:191 (opens in a new tab)

heightOrigin

get heightOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.heightOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:171 (opens in a new tab)

layer

get layer(): Nullable<Layer>

set layer(layer): void

Parameters

Returns

Nullable<Layer>

Inherited from

SceneViewer.layer

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:293 (opens in a new tab)

left

get left(): number

set left(num): void

Parameters

Returns

number

Inherited from

SceneViewer.left

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:183 (opens in a new tab)

leftOrigin

get leftOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.leftOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:163 (opens in a new tab)

maxZIndex

get maxZIndex(): number

Returns

number

Inherited from

SceneViewer.maxZIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:385 (opens in a new tab)

oKey

get oKey(): string

Returns

string

Inherited from

SceneViewer.oKey

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:269 (opens in a new tab)

parent

get parent(): any

set parent(o): void

Parameters

Returns

any

Inherited from

SceneViewer.parent

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:265 (opens in a new tab)

printable

get printable(): boolean

Returns

boolean

Inherited from

SceneViewer.printable

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:155 (opens in a new tab)

scaleX

get scaleX(): number

set scaleX(scaleX): void

Parameters

Returns

number

Inherited from

SceneViewer.scaleX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:203 (opens in a new tab)

scaleY

get scaleY(): number

set scaleY(scaleY): void

Parameters

Returns

number

Inherited from

SceneViewer.scaleY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:207 (opens in a new tab)

skewX

get skewX(): number

set skewX(skewX): void

Parameters

Returns

number

Inherited from

SceneViewer.skewX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:249 (opens in a new tab)

skewY

get skewY(): number

set skewY(skewY): void

Parameters

Returns

number

Inherited from

SceneViewer.skewY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:253 (opens in a new tab)

strokeWidth

get strokeWidth(): number

set strokeWidth(width): void

Parameters

Returns

number

Inherited from

SceneViewer.strokeWidth

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:195 (opens in a new tab)

top

get top(): number

set top(num): void

Parameters

Returns

number

Inherited from

SceneViewer.top

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:179 (opens in a new tab)

topOrigin

get topOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.topOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:159 (opens in a new tab)

transform

get transform(): Transform

set transform(trans): void

Parameters

Returns

Transform

Inherited from

SceneViewer.transform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:134 (opens in a new tab)

transformerConfig

get transformerConfig(): ITransformerConfig

set transformerConfig(config): void

Parameters

Returns

ITransformerConfig

Inherited from

SceneViewer.transformerConfig

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:377 (opens in a new tab)

visible

get visible(): boolean

Returns

boolean

Inherited from

SceneViewer.visible

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:281 (opens in a new tab)

width

get width(): number

set width(num): void

Parameters

Returns

number

Inherited from

SceneViewer.width

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:187 (opens in a new tab)

widthOrigin

get widthOrigin(): string | number

Returns

string | number

Inherited from

SceneViewer.widthOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:167 (opens in a new tab)

zIndex

get zIndex(): number

set zIndex(index): void

Parameters

Returns

number

Inherited from

SceneViewer.zIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:273 (opens in a new tab)

Methods

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

SceneViewer._setTransForm

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:840 (opens in a new tab)

activeFirstPage()

activeFirstPage(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:42 (opens in a new tab)

activeSubScene()

activeSubScene(key): void

Parameters

Returns

void

Inherited from

SceneViewer.activeSubScene

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:104 (opens in a new tab)

addNavigation()

addNavigation(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:73 (opens in a new tab)

addPage()

addPage(scene): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:51 (opens in a new tab)

addSubScene()

addSubScene(scene): void

Parameters

Returns

void

Inherited from

SceneViewer.addSubScene

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:89 (opens in a new tab)

allowSelectedClipElement()

allowSelectedClipElement(): boolean

Returns

boolean

Inherited from

SceneViewer.allowSelectedClipElement

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:123 (opens in a new tab)

applyTransform()

applyTransform(): void

Returns

void

Inherited from

SceneViewer.applyTransform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:828 (opens in a new tab)

changePage()

changePage(id?): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:60 (opens in a new tab)

disableNav()

disableNav(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:134 (opens in a new tab)

disableSelectedClipElement()

disableSelectedClipElement(): void

Returns

void

Inherited from

SceneViewer.disableSelectedClipElement

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:119 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Inherited from

SceneViewer.dispose

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:138 (opens in a new tab)

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

SceneViewer.disposeWithMe

Defined in

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

enableNav()

enableNav(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:130 (opens in a new tab)

enableSelectedClipElement()

enableSelectedClipElement(): void

Returns

void

Inherited from

SceneViewer.enableSelectedClipElement

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:115 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

SceneViewer.ensureNotDisposed

Defined in

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

flip()

flip(flipX?, flipY?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.flip

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:508 (opens in a new tab)

getActiveSubScene()

getActiveSubScene(): Nullable<ThinScene>

Returns

Nullable<ThinScene>

Inherited from

SceneViewer.getActiveSubScene

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:77 (opens in a new tab)

getEngine()

getEngine(): any

Returns

any

Inherited from

SceneViewer.getEngine

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:806 (opens in a new tab)

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Returns

Vector2

Inherited from

SceneViewer.getInverseCoord

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:836 (opens in a new tab)

getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

SceneViewer.getLayerIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:821 (opens in a new tab)

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

SceneViewer.getObjects

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:817 (opens in a new tab)

getParent()

getParent(): any

Returns

any

Inherited from

SceneViewer.getParent

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:562 (opens in a new tab)

getScene()

getScene(): any

Returns

any

Inherited from

SceneViewer.getScene

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:778 (opens in a new tab)

getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

SceneViewer.getState

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:566 (opens in a new tab)

getSubScene()

getSubScene(sceneKey): undefined | ThinScene

Parameters

Returns

undefined | ThinScene

Inherited from

SceneViewer.getSubScene

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:81 (opens in a new tab)

getSubScenes()

getSubScenes(): Map<string, ThinScene>

Returns

Map<string, ThinScene>

Inherited from

SceneViewer.getSubScenes

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:73 (opens in a new tab)

hasPage()

hasPage(key): undefined | ThinScene

Parameters

Returns

undefined | ThinScene

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:69 (opens in a new tab)

hiddenNav()

hiddenNav(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:138 (opens in a new tab)

hide()

hide(): void

Returns

void

Inherited from

SceneViewer.hide

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:582 (opens in a new tab)

isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

SceneViewer.isDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:417 (opens in a new tab)

isHit()

isHit(coord): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.isHit

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:596 (opens in a new tab)

isRender()

isRender(bounds?): undefined | boolean

Parameters

Returns

undefined | boolean

Inherited from

SceneViewer.isRender

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:555 (opens in a new tab)

makeDirty()

makeDirty(state): undefined | Slide

Parameters

Returns

undefined | Slide

Inherited from

SceneViewer.makeDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:389 (opens in a new tab)

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.makeDirtyNoDebounce

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:408 (opens in a new tab)

makeForceDirty()

makeForceDirty(state): void

Parameters

Returns

void

Inherited from

SceneViewer.makeForceDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:404 (opens in a new tab)

pick()

pick(coord): Nullable<BaseObject | ThinScene>

Parameters

Returns

Nullable<BaseObject | ThinScene>

Inherited from

SceneViewer.pick

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:128 (opens in a new tab)

removeNavigation()

removeNavigation(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:120 (opens in a new tab)

removeSubScene()

removeSubScene(key): void

Parameters

Returns

void

Inherited from

SceneViewer.removeSubScene

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:95 (opens in a new tab)

removeTransform()

removeTransform(): void

Returns

void

Inherited from

SceneViewer.removeTransform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:832 (opens in a new tab)

render()

render(mainCtx, bounds?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.render

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:43 (opens in a new tab)

renderToThumb()

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

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:158 (opens in a new tab)

resetCursor()

resetCursor(): void

Returns

void

Inherited from

SceneViewer.resetCursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:797 (opens in a new tab)

resize()

resize(width?, height?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.resize

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:443 (opens in a new tab)

scale()

scale(scaleX?, scaleY?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.scale

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:464 (opens in a new tab)

setCursor()

setCursor(val): void

Parameters

Returns

void

Inherited from

SceneViewer.setCursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:801 (opens in a new tab)

show()

show(): void

Returns

void

Inherited from

SceneViewer.show

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:587 (opens in a new tab)

showNav()

showNav(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/slides/slide.ts:148 (opens in a new tab)

skew()

skew(skewX?, skewY?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.skew

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:486 (opens in a new tab)

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

SceneViewer.toJson

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:767 (opens in a new tab)

transformByState()

transformByState(option): undefined | Slide

Parameters

Returns

undefined | Slide

Inherited from

SceneViewer.transformByState

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:529 (opens in a new tab)

transformForAngle()

transformForAngle(transform): Transform

Parameters

Returns

Transform

Inherited from

SceneViewer.transformForAngle

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:139 (opens in a new tab)

translate()

translate(x?, y?): Slide

Parameters

Returns

Slide

Inherited from

SceneViewer.translate

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:421 (opens in a new tab)

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerDblclick

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:633 (opens in a new tab)

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerDragEnter

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:719 (opens in a new tab)

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerDragLeave

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:703 (opens in a new tab)

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerDragOver

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:711 (opens in a new tab)

triggerDrop()

triggerDrop(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerDrop

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:727 (opens in a new tab)

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerMouseWheel

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:653 (opens in a new tab)

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerDown

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:617 (opens in a new tab)

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerEnter

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:695 (opens in a new tab)

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerLeave

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:679 (opens in a new tab)

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerMove

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:609 (opens in a new tab)

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerOut

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:671 (opens in a new tab)

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerOver

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:687 (opens in a new tab)

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerPointerUp

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:625 (opens in a new tab)

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Returns

boolean

Inherited from

SceneViewer.triggerTripleClick

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:643 (opens in a new tab)