AdvancedCreates a GraphicsPath instance optionally from an SVG path string or an array of PathInstruction.
Optionalinstructions: string | PathInstruction[]An SVG path string or an array of PathInstruction objects.
Controls whether shapes in this path should be checked for holes using the non-zero fill rule. When true, any closed shape that is fully contained within another shape will become a hole in that shape during filling operations.
This follows SVG's non-zero fill rule where:
Mainly used internally by the SVG parser to correctly handle holes in complex paths. When false, all shapes are filled independently without checking for holes.
Readonlyuidunique id for this graphics path
Provides access to the internal shape path, ensuring it is up-to-date with the current instructions.
The ShapePath instance associated with this GraphicsPath.
Adds another GraphicsPath to this path, optionally applying a transformation.
The GraphicsPath to add.
Optionaltransform: MatrixAn optional transformation to apply to the added path.
The instance of the current object for chaining.
Adds an arc to the path. The arc is centered at (x, y)
position with radius radius starting at startAngle and ending at endAngle.
The x-coordinate of the arc's center.
The y-coordinate of the arc's center.
The radius of the arc.
The starting angle of the arc, in radians.
The ending angle of the arc, in radians.
Optionalcounterclockwise: booleanSpecifies whether the arc should be drawn in the anticlockwise direction. False by default.
The instance of the current object for chaining.
Adds an arc to the path with the arc tangent to the line joining two specified points.
The arc radius is specified by radius.
The x-coordinate of the first point.
The y-coordinate of the first point.
The x-coordinate of the second point.
The y-coordinate of the second point.
The radius of the arc.
The instance of the current object for chaining.
Adds an SVG-style arc to the path, allowing for elliptical arcs based on the SVG spec.
The x-radius of the ellipse.
The y-radius of the ellipse.
The rotation of the ellipse's x-axis relative to the x-axis of the coordinate system, in degrees.
Determines if the arc should be greater than or less than 180 degrees.
Determines if the arc should be swept in a positive angle direction.
The x-coordinate of the arc's end point.
The y-coordinate of the arc's end point.
The instance of the current object for chaining.
Adds a cubic Bezier curve to the path. It requires three points: the first two are control points and the third one is the end point. The starting point is the last point in the current path.
The x-coordinate of the first control point.
The y-coordinate of the first control point.
The x-coordinate of the second control point.
The y-coordinate of the second control point.
The x-coordinate of the end point.
The y-coordinate of the end point.
Optionalsmoothness: numberOptional parameter to adjust the smoothness of the curve.
The instance of the current object for chaining.
Adds a cubic Bezier curve to the path. It requires two points: the second control point and the end point. The first control point is assumed to be The starting point is the last point in the current path.
The x-coordinate of the second control point.
The y-coordinate of the second control point.
The x-coordinate of the end point.
The y-coordinate of the end point.
Optionalsmoothness: numberOptional parameter to adjust the smoothness of the curve.
The instance of the current object for chaining.
Draw Rectangle with chamfer corners. These are angled corners.
Upper left corner of rect
Upper right corner of rect
Width of rect
Height of rect
non-zero real number, size of corner cutout
Optionaltransform: MatrixDraws a circle shape. This method adds a new circle path to the current drawing.
The x-coordinate of the center of the circle.
The y-coordinate of the center of the circle.
The radius of the circle.
Optionaltransform: MatrixAn optional Matrix object to apply a transformation to the circle.
The instance of the current object for chaining.
Creates a copy of the current GraphicsPath instance. This method supports both shallow and deep cloning.
A shallow clone copies the reference of the instructions array, while a deep clone creates a new array and
copies each instruction individually, ensuring that modifications to the instructions of the cloned GraphicsPath
do not affect the original GraphicsPath and vice versa.
A boolean flag indicating whether the clone should be deep.
A new GraphicsPath instance that is a clone of the current instance.
Closes the current path by drawing a straight line back to the start. If the shape is already closed or there are no points in the path, this method does nothing.
The instance of the current object for chaining.
Draws an ellipse at the specified location and with the given x and y radii. An optional transformation can be applied, allowing for rotation, scaling, and translation.
The x-coordinate of the center of the ellipse.
The y-coordinate of the center of the ellipse.
The horizontal radius of the ellipse.
The vertical radius of the ellipse.
Optionalmatrix: MatrixAn optional Matrix object to apply a transformation to the ellipse. This can include rotations.
The instance of the current object for chaining.
Draw Rectangle with fillet corners. This is much like rounded rectangle however it support negative numbers as well for the corner radius.
Upper left corner of rect
Upper right corner of rect
Width of rect
Height of rect
accept negative or positive values
Retrieves the last point from the current drawing instructions in the GraphicsPath.
This method is useful for operations that depend on the path's current endpoint,
such as connecting subsequent shapes or paths. It supports various drawing instructions,
ensuring the last point's position is accurately determined regardless of the path's complexity.
If the last instruction is a closePath, the method iterates backward through the instructions
until it finds an actionable instruction that defines a point (e.g., moveTo, lineTo,
quadraticCurveTo, etc.). For compound paths added via addPath, it recursively retrieves
the last point from the nested path.
A Point object where the last point's coordinates will be stored.
This object is modified directly to contain the result.
The Point object containing the last point's coordinates.
Connects the current point to a new point with a straight line. This method updates the current path.
The x-coordinate of the new point to connect to.
The y-coordinate of the new point to connect to.
The instance of the current object for chaining.
Sets the starting point for a new sub-path. Any subsequent drawing commands are considered part of this path.
The x-coordinate for the starting point.
The y-coordinate for the starting point.
The instance of the current object for chaining.
Draws a polygon shape by specifying a sequence of points. This method allows for the creation of complex polygons, which can be both open and closed. An optional transformation can be applied, enabling the polygon to be scaled, rotated, or translated as needed.
An array of numbers representing the x and y coordinates of the polygon's vertices, in sequence.
Optionalclose: booleanA boolean indicating whether to close the polygon path. True by default.
Optionaltransform: MatrixAn optional Matrix object to apply a transformation to the polygon.
The instance of the current object for chaining further drawing commands.
Adds a quadratic curve to the path. It requires two points: the control point and the end point. The starting point is the last point in the current path.
The x-coordinate of the control point.
The y-coordinate of the control point.
The x-coordinate of the end point.
The y-coordinate of the end point.
Optionalsmoothness: numberOptional parameter to adjust the smoothness of the curve.
The instance of the current object for chaining.
Adds a quadratic curve to the path. It uses the previous point as the control point.
The x-coordinate of the end point.
The y-coordinate of the end point.
Optionalsmoothness: numberOptional parameter to adjust the smoothness of the curve.
The instance of the current object for chaining.
Draws a rectangle shape. This method adds a new rectangle path to the current drawing.
The x-coordinate of the top-left corner of the rectangle.
The y-coordinate of the top-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
Optionaltransform: MatrixAn optional Matrix object to apply a transformation to the rectangle.
The instance of the current object for chaining.
Draws a regular polygon with a specified number of sides. All sides and angles are equal.
The x-coordinate of the center of the polygon.
The y-coordinate of the center of the polygon.
The radius of the circumscribed circle of the polygon.
The number of sides of the polygon. Must be 3 or more.
Optionalrotation: numberThe rotation angle of the polygon, in radians. Zero by default.
Optionaltransform: MatrixAn optional Matrix object to apply a transformation to the polygon.
The instance of the current object for chaining.
Draws a polygon with rounded corners.
Similar to regularPoly but with the ability to round the corners of the polygon.
The x-coordinate of the center of the polygon.
The y-coordinate of the center of the polygon.
The radius of the circumscribed circle of the polygon.
The number of sides of the polygon. Must be 3 or more.
The radius of the rounding of the corners.
Optionalrotation: numberThe rotation angle of the polygon, in radians. Zero by default.
The instance of the current object for chaining.
Draws a rectangle with rounded corners. The corner radius can be specified to determine how rounded the corners should be. An optional transformation can be applied, which allows for rotation, scaling, and translation of the rectangle.
The x-coordinate of the top-left corner of the rectangle.
The y-coordinate of the top-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
Optionalradius: numberThe radius of the rectangle's corners. If not specified, corners will be sharp.
Optionaltransform: MatrixAn optional Matrix object to apply a transformation to the rectangle.
The instance of the current object for chaining.
Draws a shape with rounded corners. This function supports custom radius for each corner of the shape. Optionally, corners can be rounded using a quadratic curve instead of an arc, providing a different aesthetic.
An array of RoundedPoint representing the corners of the shape to draw.
A minimum of 3 points is required.
The default radius for the corners.
This radius is applied to all corners unless overridden in points.
OptionaluseQuadratic: booleanIf set to true, rounded corners are drawn using a quadraticCurve method instead of an arc method. Defaults to false.
Optionalsmoothness: numberSpecifies the smoothness of the curve when useQuadratic is true.
Higher values make the curve smoother.
The instance of the current object for chaining.
Draws a star shape centered at a specified location. This method allows for the creation of stars with a variable number of points, outer radius, optional inner radius, and rotation. The star is drawn as a closed polygon with alternating outer and inner vertices to create the star's points. An optional transformation can be applied to scale, rotate, or translate the star as needed.
The x-coordinate of the center of the star.
The y-coordinate of the center of the star.
The number of points of the star.
The outer radius of the star (distance from the center to the outer points).
OptionalinnerRadius: numberOptional. The inner radius of the star
(distance from the center to the inner points between the outer points).
If not provided, defaults to half of the radius.
Optionalrotation: numberOptional. The rotation of the star in radians, where 0 is aligned with the y-axis. Defaults to 0, meaning one point is directly upward.
Optionaltransform: MatrixAn optional Matrix object to apply a transformation to the star.
This can include rotations, scaling, and translations.
The instance of the current object for chaining further drawing commands.
Applies a transformation matrix to all drawing instructions within the GraphicsPath.
This method enables the modification of the path's geometry according to the provided
transformation matrix, which can include translations, rotations, scaling, and skewing.
Each drawing instruction in the path is updated to reflect the transformation, ensuring the visual representation of the path is consistent with the applied matrix.
Note: The transformation is applied directly to the coordinates and control points of the drawing instructions, not to the path as a whole. This means the transformation's effects are baked into the individual instructions, allowing for fine-grained control over the path's appearance.
A Matrix object representing the transformation to apply.
The instance of the current object for chaining further operations.
The
GraphicsPathclass is designed to represent a graphical path consisting of multiple drawing instructions. This class serves as a collection of drawing commands that can be executed to render shapes and paths on a canvas or similar graphical context. It supports high-level drawing operations like lines, arcs, curves, and more, enabling complex graphic constructions with relative ease.