svgcanvas/README.md
2014-02-21 17:35:01 -08:00

47 lines
1.4 KiB
Markdown

Canvas2Svg
==========
This library turns your Canvas into SVG using javascript. In other words, this library lets you build an SVG document using the canvas api. Why use it?
* You have a canvas drawing you want to persist as an SVG file.
* You like exporting things.
* Because you didn't want to transform your custom file format to SVG.
Demo
==========
http://gliffy.github.io/canvas2svg/
How it works
==========
We create a mock 2d canvas context. Use the canvas context like you would on a normal canvas. As you call methods, we build up a scene graph in SVG. Yay!
Usage
==========
```javascript
//Create a new mock canvas context. Pass in your desired width and height for your svg document.
var ctx = new C2S(500,500);
//draw your canvas like you would normally
ctx.fillStyle="red";
ctx.fillRect(100,100,100,100);
//etc...
//serialize your SVG
var mySerializedSVG = ctx.getSerializedSvg(); //true here, if you need to convert named to numbered entities.
//If you really need to you can access the shadow inline SVG created by calling:
var svg = ctx.getSvg();
```
Updates
==========
- v1.0.2 Split up rgba values set in fill/stroke to allow illustrator import support.
- v1.0.1 Allow C2S to be called as a function. https://github.com/gliffy/canvas2svg/issues/2
- v1.0.0 Initial release
Misc
==========
Some canvas 2d context methods are not implemented yet. Watch out for setTransform and arcTo.
License
==========
This library is licensed under the MIT license.