Path2D class

Path2D class

The Path2D interface of the Canvas 2D API is used to declare paths that are then later used on CanvasRenderingContext2D objects. The path methods of the CanvasRenderingContext2D interface are present on this interface as well and are allowing you to create paths that you can retain and replay as required on a canvas.

Inheritance: Path2DDOMObject

The Path2D type exposes the following members:

Constructors

ConstructorDescription
initreturns a newly instantiated Path2D object
initreturns a newly instantiated Path2D object with another path as an argument (creates a copy)
initreturns a newly instantiated Path2D object with a string consisting of SVG path data.

Methods

MethodDescription
add_pathAdds to the path the path given by the argument.
add_pathAdds to the path the path given by the argument.
arcAdds an arc to the path which is centered at (x, y) position with radius r starting at startAngle and ending at endAngle going in the given direction by anticlockwise (defaulting to clockwise).
arcAdds an arc to the path which is centered at (x, y) position with radius r starting at startAngle and ending at endAngle going in the given direction by anticlockwise (defaulting to clockwise).
ellipseAdds an ellipse to the path which is centered at (x, y) position with the radii radiusX and radiusY starting at startAngle
and ending at endAngle going in the given direction by anticlockwise (defaulting to clockwise).
ellipseAdds an ellipse to the path which is centered at (x, y) position with the radii radiusX and radiusY starting at startAngle
and ending at endAngle going in the given direction by anticlockwise (defaulting to clockwise).
get_platform_typeThis method is used to retrieve ECMAScript object Type.
close_pathCauses the point of the pen to move back to the start of the current sub-path.
It tries to draw a straight line from the current point to the start.
If the shape has already been closed or has only one point, this function does nothing.
move_toMoves the starting point of a new sub-path to the (x, y) coordinates.
line_toConnects the last point in the subpath to the x, y coordinates with a straight line.
quadratic_curve_toAdds a quadratic Bézier curve to the current path.
bezier_curve_toAdds a cubic Bézier curve to the path. It requires three points.
The first two points are control points and the third one is the end point.
The starting point is the last point in the current path,
which can be changed using moveTo() before creating the Bézier curve.
arc_toAdds an arc to the path with the given control points and radius, connected to the previous point by a straight line.
rectCreates a path for a rectangle at position (x, y) with a size that is determined by width and height.

See Also