d3-path

The inverse of new Path2D(string). Now you can write code that renders to either Canvas or SVG! For example:

var context = path();
context.beginPath();
context.moveTo(150, 20);
context.lineTo(150, 100);
context.closePath();
context.toString(); // "M150,20L150,100Z"

Installing

If you use NPM, npm install d3-path. Otherwise, download the latest release.

API Reference

# path()

Constructs a new path serializer.

# path.beginPath()

Empties the list of subpaths. Equivalent to context.beginPath. Immediately after this call, path.toString will return the empty string.

# path.moveTo(x, y)

Move to the specified point ⟨x, y⟩. Equivalent to context.moveTo and SVG’s “moveto” command.

# path.closePath()

Ends the current subpath and causes an automatic straight line to be drawn from the current point to the initial point of the current subpath. Equivalent to context.closePath and SVG’s “closepath” command.

# path.lineTo(x, y)

Draws a straight line from the current point to the specified point ⟨x, y⟩. Equivalent to context.lineTo and SVG’s “lineto” command.

# path.quadraticCurveTo(cpx, cpy, x, y)

Draws a quadratic Bézier segment from the current point to the specified point ⟨x, y⟩, with the specified control point ⟨cpx, cpy⟩. Equivalent to context.quadraticCurveTo and SVG’s quadratic Bézier curve commands.

# path.bezierCurveTo(cpx1, cpy1, cpx2, cpy2, x, y)

Draws a cubic Bézier segment from the current point to the specified point ⟨x, y⟩, with the specified control points ⟨cpx1, cpy1⟩ and ⟨cpx2, cpy2⟩. Equivalent to context.bezierCurveTo and SVG’s cubic Bézier curve commands.

# path.arcTo(x1, y1, x2, y2, radius)

Draws a circular arc segment with the specified radius that starts tangent to the line between the current point and the specified point ⟨x1, y1⟩ and ends tangent to the line between the specified points ⟨x1, y1⟩ and ⟨x2, y2⟩. If the first tangent point is not equal to the current point, a straight line is drawn between the current point and the first tangent point. Equivalent to context.arcTo and uses SVG’s elliptical arc curve commands.

# path.arc(x, y, radius, startAngle, endAngle)

Draws a circular arc segment with the specified center ⟨x, y⟩, radius, startAngle and endAngle. If the current point is not equal to the starting point of the arc, a straight line is drawn from the current point to the start of the arc. Equivalent to context.arc and uses SVG’s elliptical arc curve commands.

# path.rect(x, y, w, h)

Creates a new subpath containing just the four points ⟨x, y⟩, ⟨x + w, y⟩, ⟨x + w, y + h⟩, ⟨x, y + h⟩, with those four points connected by straight lines, and then marks the subpath as closed. Equivalent to context.rect and uses SVG’s “lineto” commands.

# path.toString()

Returns the string representation of this path according to SVG’s path data specficiation.