@univerjs/engine-render v0.1.17 • Docs

Class: abstract BaseObject

Extends

• Disposable

Extended by

• RenderComponent
• CustomObject
• Group
• SceneViewer
• RichText
• Shape

Constructors

new BaseObject()

new BaseObject(key?): BaseObject

Parameters

Returns

BaseObject

Overrides

Disposable.constructor

Defined in

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

Properties

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Defined in

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

ancestorLeft

get ancestorLeft(): any

Returns

any

Defined in

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

ancestorScaleX

get ancestorScaleX(): number

Returns

number

Defined in

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

ancestorScaleY

get ancestorScaleY(): number

Returns

number

Defined in

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

ancestorTop

get ancestorTop(): any

Returns

any

Defined in

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

ancestorTransform

get ancestorTransform(): any

Returns

any

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

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

Defined in

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

cursor

get cursor(): CURSOR_TYPE

set cursor(val): void

Parameters

Returns

CURSOR_TYPE

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

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

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

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

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

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

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>

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

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

Defined in

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

maxZIndex

get maxZIndex(): number

Returns

number

Defined in

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

oKey

get oKey(): string

Returns

string

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

Defined in

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

printable

get printable(): boolean

Returns

boolean

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

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

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

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

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

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

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

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

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

Defined in

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

visible

get visible(): boolean

Returns

boolean

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

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

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

Defined in

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

Methods

_setTransForm()

protected _setTransForm(): void

Returns

void

Defined in

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

applyTransform()

applyTransform(): void

Returns

void

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

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

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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

flip()

flip(flipX?, flipY?): BaseObject

Parameters

Returns

BaseObject

Defined in

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

getEngine()

getEngine(): any

Returns

any

Defined in

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

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Returns

Vector2

Defined in

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

getLayerIndex()

getLayerIndex(): number

Returns

number

Defined in

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

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Defined in

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

getParent()

getParent(): any

Returns

any

Defined in

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

getScene()

getScene(): any

Returns

any

Defined in

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

getState()

getState(): ITransformState

Returns

ITransformState

Defined in

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

hide()

hide(): void

Returns

void

Defined in

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

isDirty()

isDirty(): boolean

Returns

boolean

Defined in

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

isHit()

isHit(coord): boolean

Parameters

Returns

boolean

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

Defined in

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

makeDirty()

makeDirty(state): undefined | BaseObject

Parameters

Returns

undefined | BaseObject

Defined in

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): BaseObject

Parameters

Returns

BaseObject

Defined in

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

makeForceDirty()

makeForceDirty(state): void

Parameters

Returns

void

Defined in

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

removeTransform()

removeTransform(): void

Returns

void

Defined in

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

render()

render(ctx, bounds): void

Parameters

Returns

void

Defined in

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

resetCursor()

resetCursor(): void

Returns

void

Defined in

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

resize()

resize(width?, height?): BaseObject

Parameters

Returns

BaseObject

Defined in

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

scale()

scale(scaleX?, scaleY?): BaseObject

Parameters

Returns

BaseObject

Defined in

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

setCursor()

setCursor(val): void

Parameters

Returns

void

Defined in

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

show()

show(): void

Returns

void

Defined in

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

skew()

skew(skewX?, skewY?): BaseObject

Parameters

Returns

BaseObject

Defined in

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

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Defined in

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

transformByState()

transformByState(option): undefined | BaseObject

Parameters

Returns

undefined | BaseObject

Defined in

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

transformForAngle()

transformForAngle(transform): Transform

Parameters

Returns

Transform

Defined in

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

translate()

translate(x?, y?): BaseObject

Parameters

Returns

BaseObject

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Returns

boolean

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Returns

boolean

Defined in

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