Nucleus Powered Mitochondria

    svg-path-properties
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.11 • Public • Published

    Build Status Coverage Status

    svg-path-properties

    Pure Javascript alternative to getPointAtLength(t) and getTotalLength() functions. Works with Canvas objects and when Node

    JavaScript can access to path elements properties in a browser, such as its length and the point at a given length. Unfortunately, this can't be achieved using a Canvas element or when working with node. This library can be used to replace this need. It has no dependencies on other JavaScript libraries.

    INSTALL

    To use with npm, just type

    npm install svg-path-properties
    

    You can use it int he browser directly by including svg-path-properties.min.js from the dist directory

    <script src="svg-path-properties.min.js"></script>
    

    USAGE

    The available methods are:

    const path = require("svg-path-properties");
    const properties = new path.svgPathProperties("M0,100 Q50,-50 100,100 T200,100");
    const length = properties.getTotalLength();
    const point = properties.getPointAtLength(200);
    const tangent = properties.getTangentAtLength(200);
    const allProperties = properties.getPropertiesAtLength(200);
    const parts = properties.getParts();
    

    Node:

    const path = require("svg-path-properties");
    const properties = new path.svgPathProperties("M0,100 Q50,-50 100,100 T200,100");
    

    Including it from an import:

    import { svgPathProperties } from "svg-path-properties";
    const properties = new svgPathProperties("M0,100 Q50,-50 100,100 T200,100");
    

    Including the script in the browser

    Once the script tag has been included,

    const properties = new svgPathProperties.svgPathProperties("M0,100 Q50,-50 100,100 T200,100");
    

    Using new

    Since svgPathProperties is a class, using new is the correct way to initilize it. For backwards compatibility reasons, the object can be get without it:

    const properties = svgPathProperties("M0,100 Q50,-50 100,100 T200,100");
    

    Some usage examples

    Typescript

    The TypeScript declaration file is available too, since version 0.5.0 From version 1.0.0, the whole library has been rewritten using TypeScript, and the types are auto-generated.

    CREDITS

    Some parts of the code are taken from other libraries or questions at StackOverflow:

    For Bézier curves:

    For path parsing:

    Install

    npm i svg-path-properties

    DownloadsWeekly Downloads

    33,959

    Version

    1.0.11

    License

    ISC

    Unpacked Size

    207 kB

    Total Files

    41

    Last publish

    Collaborators

    • rveciana