pathinator

Pathinator

SVG path builder and minifier

Installation

npm install pathinator

Path

• Path
  • new Path([path])
  • .length ⇒ integer
  • .import(path) ⇒ object
  • .move(...args) ⇒ object
  • .line(...args) ⇒ object
  • .cubic(...args) ⇒ object
  • .quadratic(...args) ⇒ object
  • .arc(...args) ⇒ object
  • .close(...args) ⇒ object
  • .update(index, values) ⇒ object
  • .eachPoint(callback) ⇒ object
  • .export([settings]) ⇒ Promise.<string>

new Path([path])

Parse, build, and optimize SVG path data.

Param	Type	Description
[path]	string	Optional path data to parse.

Example

import { Path } from 'pathinator';

const path = new Path()
    .move(50, 100)
    .line(100, 100)
    .line(200, 200)
    .close();

path.length ⇒ integer

The total number of commands in this path.

path.import(path) ⇒ object     🔗 Chainable

Import a path string.

Returns: object - this

Param	Type	Description
path	string	A valid path data string or polygon string.

path.move(...args) ⇒ object     🔗 Chainable

Add a move command.

Returns: object - this

Param	Type	Description
...args	number	x and y coordinates.

path.line(...args) ⇒ object     🔗 Chainable

Add a line command.

Returns: object - this

Param	Type	Description
...args	number	x and y coordinates.

path.cubic(...args) ⇒ object     🔗 Chainable

Add a quadratic bezier curve command.

Returns: object - this

Param	Type	Description
...args	number	Series of coordinates.

path.quadratic(...args) ⇒ object     🔗 Chainable

Add a quadratic bezier curve command.

Returns: object - this

Param	Type	Description
...args	number	Series of coordinates.

path.arc(...args) ⇒ object     🔗 Chainable

Add an arc command.

Returns: object - this

Param	Type	Description
...args	number	Series of coordinates / values.

path.close(...args) ⇒ object     🔗 Chainable

Add a close command.

Returns: object - this

Param	Type	Description
...args	number	Move to coordinates.

path.update(index, values) ⇒ object     🔗 Chainable

Update command values at a specific index.

Returns: object - this

Param	Type	Description
index	integer	Index of the command to update.
values	string, Array.<number>	New values for the command at this index.

path.eachPoint(callback) ⇒ object     🔗 Chainable

Calls callback for each point in the path.

Returns: object - this

Param	Type	Description
callback	function	Provides three arguments: the Point, a boolean indicating if the point is a control point, and the command index.

path.export([settings]) ⇒ Promise.<string>

Export a string of the path.

Param	Type	Default	Description
[settings]	object		Optional settings object.
[settings.coordinates]	string	"initial"	'absolute' to convert all coordinates to absolute, 'relative' to convert all coordinates to relative, 'auto' to convert coordinates to whichever is the fewest characters, 'initial' (default) to retain the coordinates set on each command
[settings.compress]	boolean		Remove excess whitespace and unnecessary characters.
[settings.combine]	boolean	true	Combine consecutive commands that are redundant.
[settings.fractionDigits]	integer	3	Round all numbers in path to a specified number of fraction digits.
[settings.scale]	number, Point		Scale the entire path. If a number is provided then x and y are scaled the same. To scale x and y differently provide a Point
[settings.translate]	number, Point		Translate the entire string a specified distance. If a number is provided then x and y are translated the same. To translated x and y differently provide a Point
[settings.maxCharsPerLine]	number, Point		Add newlines at logical breaks in the path to improve readability.
[settings.commandsOnNewLines]	number, Point		Add a newline between each command.
[settings.toPolygon]	boolean		Format the string for use in a polygon element. Sets coordinates to 'absolute'.
[settings.async]	boolean	false	Process each command in a separate Promise.