# svg-path-generator

> Easily generate svg path strings

Latest version **1.1.0** (published 2015-01-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install svg-path-generator
pnpm add svg-path-generator
yarn add svg-path-generator
bun add svg-path-generator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-01-13 |
| First published | 2014-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 60 |
| Author | Matthew Conlen |
| Maintainers | mathisonian |
| Keywords | svg, path, svg-path, svg-path-generator |

## Links

- npm: https://www.npmjs.com/package/svg-path-generator
- Repository: http://github.com/mathisonian/svg-path-generator
- Homepage: https://github.com/mathisonian/svg-path-generator
- Issues: https://github.com/mathisonian/svg-path-generator/issues
- npm.io page: https://npm.io/package/svg-path-generator

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2015-01-13
- 1.0.0 — 2014-10-27
- 0.1.0 — 2014-10-26

## README

# svg path generator

## utilities to generate svg paths

## installation

use with node or in browser with browserify

```
npm install svg-path-generator
```

## usage

```
var Path = require('svg-path-generator');

var path = Path()
            .moveTo(10, 25)
            .lineTo(10, 75)
            .lineTo(60, 75)
            .lineTo(10, 25)
            .end();

console.log(path) // M 10 25 L 10 75 L 60 75 L 10 25

```

to use relative coordinates, call `.relative()` before any method

e.g.
```
var Path = require('svg-path-generator');

var path = Path()
            .moveTo(10, 25)
            .relative().lineTo(0, 50)
            .relative().lineTo(50, 0)
            .relative().lineTo(-50, -50)
            .end();

console.log(path) // M 10 25 l 0 50 l 50 0 l -50 -50

```

both paths are equivalent.



## methods

### svg path methods

* `moveTo(x, y)`
    * moves current position to x,y without drawing anything
    * multiple sets of coordinates can be provided, i.e. `Path.moveTo(x1, y1, x2, y2)` is equivalent to `Path.moveTo(x1, y1).moveTo(x2, y2)`
* `lineTo(x, y)`
    * moves current position to x,y while drawing a line from previous position
    * multiple sets of coordinates can be provided
* `horizontalLineTo(x)`
    * move from previous position along the x axis, drawing a line
* `verticalLineTo(y)`
    * move from previous position along the y axis, drawing a line
* `curveTo(x1, y1, x2, y2, x, y)`
    * Draws a cubic Bézier curve from the current point to (x,y) using (x1,y1) as the control point at the beginning of the curve and (x2,y2) as the control point at the end of the curve.
    * multiple sets of coordinates can be provided

* `smoothCurveTo(x2, y2, x, y)`
    * Draws a cubic Bézier curve from the current point to (x,y). The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point.
    * multiple sets of coordinates can be provided

* `bezierCurveTo(x1, y1, x, y)`
    * Draws a quadratic Bézier curve from the current point to (x,y) using (x1,y1) as the control point. 
    * multiple sets of coordinates can be provided

* `smoothBezierCurveTo(x, y)`
    * Draws a quadratic Bézier curve from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point.
    * multiple sets of coordinates can be provided

* `ellipticalArc(rx, ry, xAxisRotation, largeArcFlag, sweepFlag, x, y)`
    * Draws an elliptical arc from the current point to (x, y). The size and orientation of the ellipse are defined by two radii (rx, ry) and an x-axis-rotation, which indicates how the ellipse as a whole is rotated relative to the current coordinate system. The center (cx, cy) of the ellipse is calculated automatically to satisfy the constraints imposed by the other parameters. large-arc-flag and sweep-flag contribute to the automatic calculations and help determine how the arc is drawn.

* `close()`
    * closes the current path

### other methods

* `.relative()` call before any method to have the method accept relative instead of absolute coordinates
* `.end()` converts the Path object to a string. This also gets called on the `.toString()` method


## license

MIT

---
_Source: https://npm.io/package/svg-path-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
