ShapePath
ShapePath class
Represents a creation path consisting of a series of moves, lines and curves that when combined will form a geometric shape.
class ShapePath;
Constructors
Constructor | Description |
---|---|
constructor() | Initializes a new instance of the ShapePath class. |
Properties
Property | Type | Description |
---|---|---|
pathSegementList | ShapeSegmentPathCollection | Readonly. Gets ShapeSegmentPathCollection list |
widthPixel | number | Gets the width of this path in unit of pixels. |
heightPixel | number | Gets the height of this path in unit of pixels. |
Methods
Method | Description |
---|---|
getPathSegementList() | @deprecated. Please use the ‘pathSegementList’ property instead. Gets ShapeSegmentPathCollection list |
getWidthPixel() | @deprecated. Please use the ‘widthPixel’ property instead. Gets the width of this path in unit of pixels. |
setWidthPixel(number) | @deprecated. Please use the ‘widthPixel’ property instead. Gets the width of this path in unit of pixels. |
getHeightPixel() | @deprecated. Please use the ‘heightPixel’ property instead. Gets the height of this path in unit of pixels. |
setHeightPixel(number) | @deprecated. Please use the ‘heightPixel’ property instead. Gets the height of this path in unit of pixels. |
moveTo(number, number) | Starts a new figure from the specified point without closing the current figure. All subsequent points added to the path are added to this new figure. |
lineTo(number, number) | Appends a line segment to the current figure. The starting point is the end point of the current figure. |
cubicBezierTo(number, number, number, number, number, number) | Appends a cubic Bézier curve to the current figure. The starting point is the end point of the current figure. |
arcTo(number, number, number, number) | Appends an elliptical arc to the current figure. The starting point is the end point of the current figure. |
close() | Closes the current figure and starts a new figure. If the current figure contains a sequence of connected lines and curves, the method closes the loop by connecting a line from the endpoint to the starting point. |
isNull() | Checks whether the implementation object is null. |
constructor()
Initializes a new instance of the ShapePath class.
constructor();
pathSegementList
Readonly. Gets ShapeSegmentPathCollection list
pathSegementList : ShapeSegmentPathCollection;
widthPixel
Gets the width of this path in unit of pixels.
widthPixel : number;
heightPixel
Gets the height of this path in unit of pixels.
heightPixel : number;
getPathSegementList()
@deprecated. Please use the ‘pathSegementList’ property instead. Gets ShapeSegmentPathCollection list
getPathSegementList() : ShapeSegmentPathCollection;
Returns
getWidthPixel()
@deprecated. Please use the ‘widthPixel’ property instead. Gets the width of this path in unit of pixels.
getWidthPixel() : number;
setWidthPixel(number)
@deprecated. Please use the ‘widthPixel’ property instead. Gets the width of this path in unit of pixels.
setWidthPixel(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getHeightPixel()
@deprecated. Please use the ‘heightPixel’ property instead. Gets the height of this path in unit of pixels.
getHeightPixel() : number;
setHeightPixel(number)
@deprecated. Please use the ‘heightPixel’ property instead. Gets the height of this path in unit of pixels.
setHeightPixel(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
moveTo(number, number)
Starts a new figure from the specified point without closing the current figure. All subsequent points added to the path are added to this new figure.
moveTo(x: number, y: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
x | number | The x-coordinate of the starting point of the figure(Unit: Pixel). |
y | number | The y-coordinate of the starting point of the figure(Unit: Pixel). |
lineTo(number, number)
Appends a line segment to the current figure. The starting point is the end point of the current figure.
lineTo(x: number, y: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
x | number | The x-coordinate of the endpoint of the line segment(Unit: Pixel). |
y | number | The y-coordinate of the endpoint of the line segment(Unit: Pixel). |
cubicBezierTo(number, number, number, number, number, number)
Appends a cubic Bézier curve to the current figure. The starting point is the end point of the current figure.
cubicBezierTo(ctrX1: number, ctrY1: number, ctrX2: number, ctrY2: number, endX: number, endY: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
ctrX1 | number | The x-coordinate of the first control point for the curve(Unit: Pixel). |
ctrY1 | number | The y-coordinate of the first control point for the curve(Unit: Pixel). |
ctrX2 | number | The x-coordinate of the second control point for the curve(Unit: Pixel). |
ctrY2 | number | The y-coordinate of the second control point for the curve(Unit: Pixel). |
endX | number | The x-coordinate of the endpoint of the curve(Unit: Pixel). |
endY | number | The y-coordinate of the endpoint of the curve(Unit: Pixel). |
arcTo(number, number, number, number)
Appends an elliptical arc to the current figure. The starting point is the end point of the current figure.
arcTo(wR: number, hR: number, stAng: number, swAng: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
wR | number | The half-width of the rectangular area of the ellipse that draws the arc(Unit: Pixel). |
hR | number | The half-height of the rectangular area of the ellipse that draws the arc(Unit: Pixel). |
stAng | number | The starting angle of the arc, measured in degrees clockwise from the x-axis(Unit: Degree). |
swAng | number | The angle between startAngle and the end of the arc.(Unit: Degree) |
close()
Closes the current figure and starts a new figure. If the current figure contains a sequence of connected lines and curves, the method closes the loop by connecting a line from the endpoint to the starting point.
close() : void;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;