pathinator v0.4.3

Pathinator

SVG path builder and minifier

Installation

npm install pathinator

optimizeSvgPaths(input, settings) ⇒ Promise.<(string|Document)>

Optimize all the paths in an svg file. Currently supports the d attribute in the path element and the points attribute in both polygon and polyline elements.

Returns: Promise.<(string|Document)> - Resolves with the optimized svg in the same format provided.

Example

import { optimizeSvgPaths } from 'pathinator';

const svg = document.querySelector('svg');

optimizeSvgPaths(svg, { compress: true })
    .then((result) => {
        // do something
    });

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
  • .transform([settings]) ⇒ object
  • .export([settings]) ⇒ Promise.<string>

new Path(path)

Parse, build, and optimize SVG path data.

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. Removes any previous commands and create a new one.

Returns: object - Returns this.

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

Add a move command.

Returns: object - Returns this.

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

Add a line command.

Returns: object - Returns this.

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

Add a quadratic bezier curve command.

Returns: object - Returns this.

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

Add a quadratic bezier curve command.

Returns: object - Returns this.

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

Add an arc command.

Returns: object - Returns this.

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

Add a close command.

Returns: object - Returns this.

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

Update command values at a specific index.

Returns: object - Returns this.

path.eachPoint(callback) ⇒ object     🔗 Chainable

Calls callback for each point in the path.

Returns: object - Returns this.

path.transform(settings) ⇒ object     🔗 Chainable

Transform all commands in path.

Returns: object - Returns this.

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

Export a string of the path. Transforms are only applied to the exported path.