scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-08-10 21:19:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions1

Add options.matchShapes support to #exportSVG and improve documentation of various import / export functions.

Browse source
This commit is contained in:
Jürg Lehni 2013-10-30 16:18:59 +01:00
parent 5d7c7a2409
commit 2a9fe48cc9
3 changed files with 67 additions and 20 deletions
src/project
Project.js

32
src/project/Project.js
View file

@ -292,11 +292,15 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
};
}, /** @lends Project# */{
/**
* {@grouptitle Importing To / Exporting From JSON & SVG}
* {@grouptitle Importing / Exporting JSON and SVG}
*
* Exports (serializes) the project with all its layers and child items to
* a JSON data string.
*
* The options object offers control over some aspects of the SVG export:
* <b>options.precision:</b> {@code Number} – the amount of fractional
* digits in numbers used in JSON data.
*
* @name Project#exportJSON
* @function
* @param {Object} [options={ precision: 5 }] the serialization options
@ -304,9 +308,9 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
*/
/**
* Imports (deserializes) the stored JSON data into the project. Note that
* the project is not cleared first. You can call {@link Project#clear()} to
* do so.
* Imports (deserializes) the stored JSON data into the project.
* Note that the project is not cleared first. You can call
* {@link Project#clear()} to do so.
*
* @param {String} json the JSON data to import from.
*/
@ -319,20 +323,36 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
* Exports the project with all its layers and child items as an SVG DOM,
* all contained in one top level SVG group node.
*
* The options object offers control over some aspects of the SVG export:
* <b>options.asString:</b> {@code Boolean} – wether a SVG node or a String
* is to be returned.
* <b>options.precision:</b> {@code Number} – the amount of fractional
* digits in numbers used in SVG data.
* <b>options.matchShapes:</b> {@code Boolean} – wether imported path
* items should tried to be converted to shape items, if their geometries
* match.
*
* @name Project#exportSVG
* @function
* @param {Object} [options={ asString: false, precision: 5 }] the export
* options.
* @param {Object} [options={ asString: false, precision: 5,
* matchShapes: false }] the export options.
* @return {SVGSVGElement} the project converted to an SVG node
*/
/**
* Converts the provided SVG content into Paper.js items and adds them to
* the active layer of this project.
* Note that the project is not cleared first. You can call
* {@link Project#clear()} to do so.
*
* The options object offers control over some aspects of the SVG import:
* <b>options.expandShapes:</b> {@code Boolean} – wether imported shape
* items should be expanded to path items.
*
* @name Project#importSVG
* @function
* @param {SVGSVGElement|String} svg the SVG content to import
* @param {Object} [options={ expandShapes: false }] the import options
* @return {Item} the imported Paper.js parent item
*/