@univerjs/engine-render v0.4.2 • Docs

Class: abstract Shape<T>

Extends

• BaseObject

Extended by

• Checkbox
• Circle
• Image
• Path
• Rect
• RegularPolygon

Type Parameters

Constructors

new Shape()

new Shape<T>(key?, props?): Shape<T>

Parameters

Returns

Shape<T>

Overrides

BaseObject.constructor

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:142 (opens in a new tab)

Properties

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

BaseObject.ancestorGroup

Defined in

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

ancestorLeft

get ancestorLeft(): any

Returns

any

Inherited from

BaseObject.ancestorLeft

Defined in

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

ancestorScaleX

get ancestorScaleX(): number

Returns

number

Inherited from

BaseObject.ancestorScaleX

Defined in

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

ancestorScaleY

get ancestorScaleY(): number

Returns

number

Inherited from

BaseObject.ancestorScaleY

Defined in

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

ancestorTop

get ancestorTop(): any

Returns

any

Inherited from

BaseObject.ancestorTop

Defined in

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

ancestorTransform

get ancestorTransform(): any

Returns

any

Inherited from

BaseObject.ancestorTransform

Defined in

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

angle

get angle(): number

set angle(angle): void

Parameters

Returns

number

Inherited from

BaseObject.angle

Defined in

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

classType

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

BaseObject.classType

Defined in

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

cursor

get cursor(): CURSOR_TYPE

set cursor(val): void

Parameters

Returns

CURSOR_TYPE

Inherited from

BaseObject.cursor

Defined in

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

debounceParentDirty

get debounceParentDirty(): boolean

set debounceParentDirty(state): void

Parameters

Returns

boolean

Inherited from

BaseObject.debounceParentDirty

Defined in

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

evented

get evented(): boolean

set evented(state): void

Parameters

Returns

boolean

Inherited from

BaseObject.evented

Defined in

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

fill

get fill(): Nullable<string | CanvasGradient>

Returns

Nullable<string | CanvasGradient>

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:176 (opens in a new tab)

fillAfterStrokeEnabled

get fillAfterStrokeEnabled(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:180 (opens in a new tab)

fillRule

get fillRule(): string

Returns

string

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:156 (opens in a new tab)

flipX

get flipX(): boolean

set flipX(flipX): void

Parameters

Returns

boolean

Inherited from

BaseObject.flipX

Defined in

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

flipY

get flipY(): boolean

set flipY(flipY): void

Parameters

Returns

boolean

Inherited from

BaseObject.flipY

Defined in

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

globalCompositeOperation

get globalCompositeOperation(): string

Returns

string

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:160 (opens in a new tab)

height

get height(): number

set height(num): void

Parameters

Returns

number

Inherited from

BaseObject.height

Defined in

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

heightOrigin

get heightOrigin(): string | number

Returns

string | number

Inherited from

BaseObject.heightOrigin

Defined in

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

hitStrokeWidth

get hitStrokeWidth(): string | number

Returns

string | number

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:184 (opens in a new tab)

hoverCursor

get hoverCursor(): Nullable<string>

Returns

Nullable<string>

Defined in

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

layer

get layer(): Nullable<Layer>

set layer(layer): void

Parameters

Returns

Nullable<Layer>

Inherited from

BaseObject.layer

Defined in

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

left

get left(): number

set left(num): void

Parameters

Returns

number

Inherited from

BaseObject.left

Defined in

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

leftOrigin

get leftOrigin(): string | number

Returns

string | number

Inherited from

BaseObject.leftOrigin

Defined in

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

maxZIndex

get maxZIndex(): number

Returns

number

Inherited from

BaseObject.maxZIndex

Defined in

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

moveCursor

get moveCursor(): null | string

Returns

null | string

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:152 (opens in a new tab)

oKey

get oKey(): string

Returns

string

Inherited from

BaseObject.oKey

Defined in

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

paintFirst

get paintFirst(): PaintFirst

Returns

PaintFirst

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:164 (opens in a new tab)

parent

get parent(): any

set parent(o): void

Parameters

Returns

any

Inherited from

BaseObject.parent

Defined in

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

printable

get printable(): boolean

Returns

boolean

Inherited from

BaseObject.printable

Defined in

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

scaleX

get scaleX(): number

set scaleX(scaleX): void

Parameters

Returns

number

Inherited from

BaseObject.scaleX

Defined in

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

scaleY

get scaleY(): number

set scaleY(scaleY): void

Parameters

Returns

number

Inherited from

BaseObject.scaleY

Defined in

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

shadowBlur

get shadowBlur(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:200 (opens in a new tab)

shadowColor

get shadowColor(): Nullable<string>

Returns

Nullable<string>

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:196 (opens in a new tab)

shadowEnabled

get shadowEnabled(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:220 (opens in a new tab)

shadowForStrokeEnabled

get shadowForStrokeEnabled(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:224 (opens in a new tab)

shadowOffset

get shadowOffset(): Nullable<Vector2>

Returns

Nullable<Vector2>

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:204 (opens in a new tab)

shadowOffsetX

get shadowOffsetX(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:208 (opens in a new tab)

shadowOffsetY

get shadowOffsetY(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:212 (opens in a new tab)

shadowOpacity

get shadowOpacity(): number

Returns

number

Defined in

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

skewX

get skewX(): number

set skewX(skewX): void

Parameters

Returns

number

Inherited from

BaseObject.skewX

Defined in

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

skewY

get skewY(): number

set skewY(skewY): void

Parameters

Returns

number

Inherited from

BaseObject.skewY

Defined in

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

stroke

get stroke(): Nullable<string | CanvasGradient>

Returns

Nullable<string | CanvasGradient>

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:168 (opens in a new tab)

strokeDashArray

get strokeDashArray(): Nullable<number[]>

Returns

Nullable<number[]>

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:228 (opens in a new tab)

strokeDashOffset

get strokeDashOffset(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:232 (opens in a new tab)

strokeLineCap

get strokeLineCap(): LineCap

Returns

LineCap

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:192 (opens in a new tab)

strokeLineJoin

get strokeLineJoin(): LineJoin

Returns

LineJoin

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:188 (opens in a new tab)

strokeMiterLimit

get strokeMiterLimit(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:236 (opens in a new tab)

strokeScaleEnabled

get strokeScaleEnabled(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:172 (opens in a new tab)

strokeWidth

get strokeWidth(): number

set strokeWidth(width): void

Parameters

Returns

number

Inherited from

BaseObject.strokeWidth

Defined in

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

top

get top(): number

set top(num): void

Parameters

Returns

number

Inherited from

BaseObject.top

Defined in

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

topOrigin

get topOrigin(): string | number

Returns

string | number

Inherited from

BaseObject.topOrigin

Defined in

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

transform

get transform(): Transform

set transform(trans): void

Parameters

Returns

Transform

Inherited from

BaseObject.transform

Defined in

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

transformerConfig

get transformerConfig(): ITransformerConfig

set transformerConfig(config): void

Parameters

Returns

ITransformerConfig

Inherited from

BaseObject.transformerConfig

Defined in

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

visible

get visible(): boolean

Returns

boolean

Inherited from

BaseObject.visible

Defined in

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

width

get width(): number

set width(num): void

Parameters

Returns

number

Inherited from

BaseObject.width

Defined in

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

widthOrigin

get widthOrigin(): string | number

Returns

string | number

Inherited from

BaseObject.widthOrigin

Defined in

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

zIndex

get zIndex(): number

set zIndex(index): void

Parameters

Returns

number

Inherited from

BaseObject.zIndex

Defined in

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

Methods

_draw()

protected _draw(ctx, bounds?): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:387 (opens in a new tab)

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

BaseObject._setTransForm

Defined in

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

applyTransform()

applyTransform(): void

Returns

void

Inherited from

BaseObject.applyTransform

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

BaseObject.dispose

Defined in

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

BaseObject.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

BaseObject.ensureNotDisposed

Defined in

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

flip()

flip(flipX?, flipY?): Shape<T>

Parameters

Returns

Shape<T>

Inherited from

BaseObject.flip

Defined in

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

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

BaseObject.getEngine

Defined in

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

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Returns

Vector2

Inherited from

BaseObject.getInverseCoord

Defined in

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

getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

BaseObject.getLayerIndex

Defined in

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

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

BaseObject.getObjects

Defined in

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

getParent()

getParent(): any

Returns

any

Inherited from

BaseObject.getParent

Defined in

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

getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

BaseObject.getScene

Defined in

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

getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

BaseObject.getState

Defined in

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

hide()

hide(): void

Returns

void

Inherited from

BaseObject.hide

Defined in

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

isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

BaseObject.isDirty

Defined in

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

isHit()

isHit(coord): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.isHit

Defined in

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

isRender()

isRender(bounds?): undefined | boolean

Parameters

Returns

undefined | boolean

Inherited from

BaseObject.isRender

Defined in

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

makeDirty()

makeDirty(state): undefined | Shape<T>

Parameters

Returns

undefined | Shape<T>

Inherited from

BaseObject.makeDirty

Defined in

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Shape<T>

Parameters

Returns

Shape<T>

Inherited from

BaseObject.makeDirtyNoDebounce

Defined in

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

makeForceDirty()

makeForceDirty(state): void

Parameters

Returns

void

Inherited from

BaseObject.makeForceDirty

Defined in

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

removeTransform()

removeTransform(): void

Returns

void

Inherited from

BaseObject.removeTransform

Defined in

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

render()

render(mainCtx, bounds?): Shape<T>

Parameters

Returns

Shape<T>

Overrides

BaseObject.render

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:319 (opens in a new tab)

resetCursor()

resetCursor(): void

Returns

void

Inherited from

BaseObject.resetCursor

Defined in

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

resize()

resize(width?, height?): Shape<T>

Parameters

Returns

Shape<T>

Inherited from

BaseObject.resize

Defined in

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

scale()

scale(scaleX?, scaleY?): Shape<T>

Parameters

Returns

Shape<T>

Inherited from

BaseObject.scale

Defined in

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

setCursor()

setCursor(val): void

Parameters

Returns

void

Inherited from

BaseObject.setCursor

Defined in

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

setProps()

setProps(props?): Shape<T>

this[_key] = props[key]

Parameters

Returns

Shape<T>

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:352 (opens in a new tab)

show()

show(): void

Returns

void

Inherited from

BaseObject.show

Defined in

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

skew()

skew(skewX?, skewY?): Shape<T>

Parameters

Returns

Shape<T>

Inherited from

BaseObject.skew

Defined in

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

toJson()

toJson(): {}

Returns

{}

Overrides

BaseObject.toJson

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:374 (opens in a new tab)

transformByState()

transformByState(option): undefined | Shape<T>

this[pKey] = option[pKey]

Parameters

Returns

undefined | Shape<T>

Inherited from

BaseObject.transformByState

Defined in

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

transformForAngle()

transformForAngle(transform): Transform

Parameters

Returns

Transform

Inherited from

BaseObject.transformForAngle

Defined in

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

translate()

translate(x?, y?): Shape<T>

Parameters

Returns

Shape<T>

Inherited from

BaseObject.translate

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerDblclick

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerDragEnter

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerDragLeave

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerDragOver

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerDrop

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerMouseWheel

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerDown

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerEnter

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerLeave

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerMove

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerOut

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerOver

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerPointerUp

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Returns

boolean

Inherited from

BaseObject.triggerTripleClick

Defined in

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

_renderPaintInOrder()

protected static _renderPaintInOrder(ctx, props): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:244 (opens in a new tab)

drawWith()

static drawWith(ctx, props): void

Parameters

Returns

void

Defined in

submodules/univer/packages/engine-render/src/shape/shape.ts:240 (opens in a new tab)