@univerjs/engine-render v0.4.2 • Docs
Class: Path
Extends
Constructors
new Path()
new Path(key?, props?): Path
Parameters
Parameter | Type |
---|---|
key ? | string |
props ? | IPathProps |
Returns
Overrides
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:63 (opens in a new tab)
Properties
Accessors
ancestorGroup
get ancestorGroup(): Nullable<BaseObject>
Returns
Inherited from
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
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
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
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
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
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
Parameter | Type |
---|---|
angle | number |
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:213 (opens in a new tab)
classType
get classType(): RENDER_CLASS_TYPE
Returns
Inherited from
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
Parameter | Type |
---|---|
val | CURSOR_TYPE |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:303 (opens in a new tab)
dataArray
get dataArray(): IPathDataArray[]
Returns
IPathDataArray
[]
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:131 (opens in a new tab)
debounceParentDirty
get debounceParentDirty(): boolean
set debounceParentDirty(state): void
Parameters
Parameter | Type |
---|---|
state | boolean |
Returns
boolean
Inherited from
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
Parameter | Type |
---|---|
state | boolean |
Returns
boolean
Inherited from
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
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:176 (opens in a new tab)
fillAfterStrokeEnabled
get fillAfterStrokeEnabled(): boolean
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:180 (opens in a new tab)
fillRule
get fillRule(): string
Returns
string
Inherited from
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
Parameter | Type |
---|---|
flipX | boolean |
Returns
boolean
Inherited from
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
Parameter | Type |
---|---|
flipY | boolean |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:275 (opens in a new tab)
globalCompositeOperation
get globalCompositeOperation(): string
Returns
string
Inherited from
Shape
.globalCompositeOperation
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
Parameter | Type |
---|---|
num | string | number |
Returns
number
Inherited from
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
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
Inherited from
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
>
Inherited from
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
Parameter | Type |
---|---|
layer | Layer |
Returns
Inherited from
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
Parameter | Type |
---|---|
num | string | number |
Returns
number
Inherited from
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
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
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
Inherited from
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:283 (opens in a new tab)
paintFirst
get paintFirst(): PaintFirst
Returns
Inherited from
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
Parameter | Type |
---|---|
o | any |
Returns
any
Inherited from
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
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
Parameter | Type |
---|---|
scaleX | number |
Returns
number
Inherited from
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
Parameter | Type |
---|---|
scaleY | number |
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:221 (opens in a new tab)
shadowBlur
get shadowBlur(): number
Returns
number
Inherited from
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
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:196 (opens in a new tab)
shadowEnabled
get shadowEnabled(): boolean
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:220 (opens in a new tab)
shadowForStrokeEnabled
get shadowForStrokeEnabled(): boolean
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:224 (opens in a new tab)
shadowOffset
get shadowOffset(): Nullable<Vector2>
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:204 (opens in a new tab)
shadowOffsetX
get shadowOffsetX(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:208 (opens in a new tab)
shadowOffsetY
get shadowOffsetY(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:212 (opens in a new tab)
shadowOpacity
get shadowOpacity(): number
Returns
number
Inherited from
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
Parameter | Type |
---|---|
skewX | number |
Returns
number
Inherited from
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
Parameter | Type |
---|---|
skewY | number |
Returns
number
Inherited from
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
>
Inherited from
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
[]>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:228 (opens in a new tab)
strokeDashOffset
get strokeDashOffset(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:232 (opens in a new tab)
strokeLineCap
get strokeLineCap(): LineCap
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:192 (opens in a new tab)
strokeLineJoin
get strokeLineJoin(): LineJoin
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:188 (opens in a new tab)
strokeMiterLimit
get strokeMiterLimit(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:236 (opens in a new tab)
strokeScaleEnabled
get strokeScaleEnabled(): boolean
Returns
boolean
Inherited from
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
Parameter | Type |
---|---|
width | number |
Returns
number
Inherited from
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
Parameter | Type |
---|---|
num | string | number |
Returns
number
Inherited from
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
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
Parameter | Type |
---|---|
trans | Transform |
Returns
Inherited from
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
Parameter | Type |
---|---|
config | ITransformerConfig |
Returns
ITransformerConfig
Inherited from
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
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
Parameter | Type |
---|---|
num | string | number |
Returns
number
Inherited from
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
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
Parameter | Type |
---|---|
index | number |
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:287 (opens in a new tab)
Methods
_draw()
protected _draw(ctx): void
Parameters
Parameter | Type |
---|---|
ctx | UniverRenderingContext |
Returns
void
Overrides
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:933 (opens in a new tab)
_setTransForm()
protected _setTransForm(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:858 (opens in a new tab)
applyTransform()
applyTransform(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:846 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:753 (opens in a new tab)
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
flip()
flip(flipX?, flipY?): Path
Parameters
Parameter | Type |
---|---|
flipX ? | boolean |
flipY ? | boolean |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:522 (opens in a new tab)
getEngine()
getEngine(): Nullable<Engine>
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:824 (opens in a new tab)
getInverseCoord()
getInverseCoord(coord): Vector2
Parameters
Parameter | Type |
---|---|
coord | Vector2 |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:854 (opens in a new tab)
getLayerIndex()
getLayerIndex(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:839 (opens in a new tab)
getLength()
getLength(): number
Return length of the path.
Returns
number
length
Method
Example
var length = path.getLength();
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:848 (opens in a new tab)
getObjects()
getObjects(): BaseObject[]
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:835 (opens in a new tab)
getParent()
getParent(): any
Returns
any
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:580 (opens in a new tab)
getPointAtLength()
getPointAtLength(length): null | {
x: fromX;
y: number;
}
Get point on path at specific length of the path
Parameters
Parameter | Type | Description |
---|---|---|
length | number | length |
Returns
null
| {
x
: fromX
;
y
: number
;
}
point {x,y} point
Method
Example
var point = path.getPointAtLength(10);
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:860 (opens in a new tab)
getRect()
getRect(): {
height: number;
left: number;
top: number;
width: number;
}
Returns
{
height: number;
left: number;
top: number;
width: number;
}
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:831 (opens in a new tab)
getScene()
getScene(): Nullable<Scene>
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:796 (opens in a new tab)
getState()
getState(): {
angle: number;
flipX: boolean;
flipY: boolean;
height: number;
left: number;
scaleX: number;
scaleY: number;
skewX: number;
skewY: number;
top: number;
width: number;
}
Returns
{
angle: number;
flipX: boolean;
flipY: boolean;
height: number;
left: number;
scaleX: number;
scaleY: number;
skewX: number;
skewY: number;
top: number;
width: number;
}
Overrides
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:814 (opens in a new tab)
hide()
hide(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:600 (opens in a new tab)
isDirty()
isDirty(): boolean
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:431 (opens in a new tab)
isHit()
isHit(coord): boolean
Parameters
Parameter | Type |
---|---|
coord | Vector2 |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:614 (opens in a new tab)
isRender()
isRender(bounds?): undefined | boolean
Parameters
Parameter | Type |
---|---|
bounds ? | IViewportInfo |
Returns
undefined
| boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:573 (opens in a new tab)
makeDirty()
makeDirty(state): undefined | Path
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
undefined
| Path
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:403 (opens in a new tab)
makeDirtyNoDebounce()
makeDirtyNoDebounce(state): Path
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:422 (opens in a new tab)
makeForceDirty()
makeForceDirty(state): void
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:418 (opens in a new tab)
removeTransform()
removeTransform(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:850 (opens in a new tab)
render()
render(mainCtx, bounds?): Path
Parameters
Parameter | Type |
---|---|
mainCtx | UniverRenderingContext |
bounds ? | IViewportInfo |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:319 (opens in a new tab)
resetCursor()
resetCursor(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:815 (opens in a new tab)
resize()
resize(width?, height?): Path
Parameters
Parameter | Type |
---|---|
width ? | string | number |
height ? | string | number |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:457 (opens in a new tab)
scale()
scale(scaleX?, scaleY?): Path
Parameters
Parameter | Type |
---|---|
scaleX ? | number |
scaleY ? | number |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:478 (opens in a new tab)
setCursor()
setCursor(val): void
Parameters
Parameter | Type |
---|---|
val | CURSOR_TYPE |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:819 (opens in a new tab)
setProps()
setProps(props?): Shape<IPathProps>
this[_key] = props[key]
Parameters
Parameter | Type |
---|---|
props ? | IPathProps |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:352 (opens in a new tab)
show()
show(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:605 (opens in a new tab)
skew()
skew(skewX?, skewY?): Path
Parameters
Parameter | Type |
---|---|
skewX ? | number |
skewY ? | number |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:500 (opens in a new tab)
toJson()
toJson(): {}
Returns
{}
Overrides
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:801 (opens in a new tab)
transformByState()
transformByState(option): undefined | Path
this[pKey] = option[pKey]
Parameters
Parameter | Type |
---|---|
option | IObjectFullState |
Returns
undefined
| Path
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:547 (opens in a new tab)
transformForAngle()
transformForAngle(transform): Transform
Parameters
Parameter | Type |
---|---|
transform | Transform |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:153 (opens in a new tab)
translate()
translate(x?, y?): Path
Parameters
Parameter | Type |
---|---|
x ? | string | number |
y ? | string | number |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:435 (opens in a new tab)
triggerDblclick()
triggerDblclick(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:651 (opens in a new tab)
triggerDragEnter()
triggerDragEnter(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IDragEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:737 (opens in a new tab)
triggerDragLeave()
triggerDragLeave(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IDragEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:721 (opens in a new tab)
triggerDragOver()
triggerDragOver(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IDragEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:729 (opens in a new tab)
triggerDrop()
triggerDrop(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IDragEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:745 (opens in a new tab)
triggerMouseWheel()
triggerMouseWheel(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IWheelEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:671 (opens in a new tab)
triggerPointerDown()
triggerPointerDown(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:635 (opens in a new tab)
triggerPointerEnter()
triggerPointerEnter(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:713 (opens in a new tab)
triggerPointerLeave()
triggerPointerLeave(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:697 (opens in a new tab)
triggerPointerMove()
triggerPointerMove(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:627 (opens in a new tab)
triggerPointerOut()
triggerPointerOut(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:689 (opens in a new tab)
triggerPointerOver()
triggerPointerOver(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:705 (opens in a new tab)
triggerPointerUp()
triggerPointerUp(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:643 (opens in a new tab)
triggerTripleClick()
triggerTripleClick(evt): boolean
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
boolean
Inherited from
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
Parameter | Type |
---|---|
ctx | UniverRenderingContext |
props | IShapeProps |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/shape/shape.ts:244 (opens in a new tab)
calcLength()
static calcLength(
x,
y,
cmd,
points): number
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
cmd | string |
points | number [] |
Returns
number
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:647 (opens in a new tab)
convertEndpointToCenterParameterization()
static convertEndpointToCenterParameterization(
x1,
y1,
x2,
y2,
fa,
fs,
rx,
ry,
psiDeg): number[]
Parameters
Parameter | Type |
---|---|
x1 | number |
y1 | number |
x2 | number |
y2 | number |
fa | number |
fs | number |
rx | number |
ry | number |
psiDeg | number |
Returns
number
[]
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:737 (opens in a new tab)
drawWith()
static drawWith(ctx, props): void
Parameters
Parameter | Type |
---|---|
ctx | UniverRenderingContext |
props | IPathProps | Path |
Returns
void
Overrides
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:135 (opens in a new tab)
getLineLength()
static getLineLength(
x1,
y1,
x2,
y2): number
Parameters
Parameter | Type |
---|---|
x1 | number |
y1 | number |
x2 | number |
y2 | number |
Returns
number
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:193 (opens in a new tab)
getPointOnCubicBezier()
static getPointOnCubicBezier(
pct,
P1x,
P1y,
P2x,
P2y,
P3x,
P3y,
P4x,
P4y): {
x: number;
y: number;
}
Parameters
Parameter | Type |
---|---|
pct | number |
P1x | number |
P1y | number |
P2x | number |
P2y | number |
P3x | number |
P3y | number |
P4x | number |
P4y | number |
Returns
{
x: number;
y: number;
}
Name | Type | Defined in |
---|---|---|
x | number | submodules/univer/packages/engine-render/src/shape/path.ts:288 (opens in a new tab) |
y | number | submodules/univer/packages/engine-render/src/shape/path.ts:289 (opens in a new tab) |
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:261 (opens in a new tab)
getPointOnEllipticalArc()
static getPointOnEllipticalArc(
cx,
cy,
rx,
ry,
theta,
psi): {
x: number;
y: number;
}
Parameters
Parameter | Type |
---|---|
cx | number |
cy | number |
rx | number |
ry | number |
theta | number |
psi | number |
Returns
{
x: number;
y: number;
}
Name | Type | Defined in |
---|---|---|
x | number | submodules/univer/packages/engine-render/src/shape/path.ts:328 (opens in a new tab) |
y | number | submodules/univer/packages/engine-render/src/shape/path.ts:329 (opens in a new tab) |
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:320 (opens in a new tab)
getPointOnLine()
static getPointOnLine(
dist,
P1x,
P1y,
P2x,
P2y,
fromX?,
fromY?): {
x: fromX;
y: number;
}
Parameters
Parameter | Type |
---|---|
dist | number |
P1x | number |
P1y | number |
P2x | number |
P2y | number |
fromX ? | number |
fromY ? | number |
Returns
{
x: fromX;
y: number;
}
Name | Type | Default value | Defined in |
---|---|---|---|
x | number | fromX | submodules/univer/packages/engine-render/src/shape/path.ts:224 (opens in a new tab) |
y | number | - | submodules/univer/packages/engine-render/src/shape/path.ts:225 (opens in a new tab) |
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:197 (opens in a new tab)
getPointOnQuadraticBezier()
static getPointOnQuadraticBezier(
pct,
P1x,
P1y,
P2x,
P2y,
P3x,
P3y): {
x: number;
y: number;
}
Parameters
Parameter | Type |
---|---|
pct | number |
P1x | number |
P1y | number |
P2x | number |
P2y | number |
P3x | number |
P3y | number |
Returns
{
x: number;
y: number;
}
Name | Type | Defined in |
---|---|---|
x | number | submodules/univer/packages/engine-render/src/shape/path.ts:315 (opens in a new tab) |
y | number | submodules/univer/packages/engine-render/src/shape/path.ts:316 (opens in a new tab) |
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:293 (opens in a new tab)
parsePathData()
static parsePathData(data): IPathDataArray[]
Parameters
Parameter | Type |
---|---|
data | string |
Returns
IPathDataArray
[]
Defined in
submodules/univer/packages/engine-render/src/shape/path.ts:341 (opens in a new tab)