code.svg

0.8.2 • Public • Published

Build Status Coverage Status npm version

code.svg

A JavaScript library to create SVG art.

Features

Among other things, code.svg provides things like:

  • Abstraction layer on top of SVG
  • SVG shapes and Path manipulation
  • SVG gradients and filter support
  • Positional Layouts
    • Attractors
    • Rossler
    • Spiral
    • Grid, columns and rows
  • Masonry layout
  • ColourLovers API integration to reuse palettes and colours
  • Particle system

Usage

node <your_script.js>

or

node <your_script.js> -o file.svg

The second way generates a .svg taking the input filename as reference.

Although you can just run node to get the .svg generated, a good choice is to use nodemon instead so changes in the input file will run codesvg.js automatically and generate the svg file on the fly (in this case, input.svg)

nodemon node <your_script.js>

Requirements for the input script

There are basically two requirements to create a code.svg script.
The first one is that the script must include the codesvg.js library:

cs = require ("./codesvg.js");

The second one is that the script must end with a call to the library variable passing as parameter a Scene object containing all the information.

var scene = new Scene ();
...
cs.save(scene);

Quick Example

Let's check a simple example of how an input file looks like.
The following snippet creates a Scene, adds a Rectangle, defines some style options and then move the Rectangle so its center is at the point (250,250).

var cs = require ("./codesvg.js");
var scene = new Scene({"width":800, "height":600});
var rect = new Rect ({width:100, height:80},
                     {stroke:"#2a240f", "stroke-width":"3px", opacity:0.6})
                      .moveTo({x:250, y:250});
scene.add (rect);
cs.save(scene);

Package Sidebar

Install

npm i code.svg

Weekly Downloads

2

Version

0.8.2

License

Apache-2.0

Unpacked Size

252 kB

Total Files

57

Last publish

Collaborators

  • rubenafo