mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-03 19:45:44 -05:00
Improve docs sequence a bit.
This commit is contained in:
parent
6e9ff38c15
commit
a39eea64e9
3 changed files with 15 additions and 21 deletions
|
@ -116,12 +116,12 @@ var PaperScope = Base.extend(/** @lends PaperScope# */{
|
||||||
/**
|
/**
|
||||||
* Gives access to paper's configurable settings.
|
* Gives access to paper's configurable settings.
|
||||||
*
|
*
|
||||||
|
* @name PaperScope#settings
|
||||||
|
* @type Object
|
||||||
|
*
|
||||||
* @option settings.applyMatrix {Boolean}
|
* @option settings.applyMatrix {Boolean}
|
||||||
* @option settings.handleSize {Number}
|
* @option settings.handleSize {Number}
|
||||||
* @option settings.hitTolerance {Number}
|
* @option settings.hitTolerance {Number}
|
||||||
*
|
|
||||||
* @name PaperScope#settings
|
|
||||||
* @type Object
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -2014,15 +2014,14 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
|
||||||
* Exports (serializes) the item with its content and child items to a JSON
|
* Exports (serializes) the item with its content and child items to a JSON
|
||||||
* data string.
|
* data string.
|
||||||
*
|
*
|
||||||
* The options object offers control over some aspects of the JSON export:
|
* @name Item#exportJSON
|
||||||
|
* @function
|
||||||
*
|
*
|
||||||
* @option options.asString {Boolean} whether the JSON is returned as a
|
* @option options.asString {Boolean} whether the JSON is returned as a
|
||||||
* {@code Object} or a {@code String}.
|
* {@code Object} or a {@code String}.
|
||||||
* @option options.precision {Number} the amount of fractional digits in
|
* @option options.precision {Number} the amount of fractional digits in
|
||||||
* numbers used in JSON data.
|
* numbers used in JSON data.
|
||||||
*
|
*
|
||||||
* @name Item#exportJSON
|
|
||||||
* @function
|
|
||||||
* @param {Object} [options={ asString: true, precision: 5 }] the
|
* @param {Object} [options={ asString: true, precision: 5 }] the
|
||||||
* serialization options
|
* serialization options
|
||||||
* @return {String} the exported JSON data
|
* @return {String} the exported JSON data
|
||||||
|
@ -2050,7 +2049,8 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
|
||||||
/**
|
/**
|
||||||
* Exports the item with its content and child items as an SVG DOM.
|
* Exports the item with its content and child items as an SVG DOM.
|
||||||
*
|
*
|
||||||
* The options object offers control over some aspects of the SVG export:
|
* @name Item#exportSVG
|
||||||
|
* @function
|
||||||
*
|
*
|
||||||
* @option options.asString {Boolean} whether a SVG node or a {@code String}
|
* @option options.asString {Boolean} whether a SVG node or a {@code String}
|
||||||
* is to be returned.
|
* is to be returned.
|
||||||
|
@ -2059,8 +2059,6 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
|
||||||
* @option options.matchShapes {Boolean} whether path items should tried to
|
* @option options.matchShapes {Boolean} whether path items should tried to
|
||||||
* be converted to shape items, if their geometries can be made to match.
|
* be converted to shape items, if their geometries can be made to match.
|
||||||
*
|
*
|
||||||
* @name Item#exportSVG
|
|
||||||
* @function
|
|
||||||
* @param {Object} [options={ asString: false, precision: 5,
|
* @param {Object} [options={ asString: false, precision: 5,
|
||||||
* matchShapes: false }] the export options.
|
* matchShapes: false }] the export options.
|
||||||
* @return {SVGElement} the item converted to an SVG node
|
* @return {SVGElement} the item converted to an SVG node
|
||||||
|
@ -2073,13 +2071,12 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
|
||||||
* Note that the item is not cleared first. You can call
|
* Note that the item is not cleared first. You can call
|
||||||
* {@link Item#removeChildren()} to do so.
|
* {@link Item#removeChildren()} to do so.
|
||||||
*
|
*
|
||||||
* The options object offers control over some aspects of the SVG import:
|
* @name Item#importSVG
|
||||||
|
* @function
|
||||||
*
|
*
|
||||||
* @option options.expandShapes {Boolean} whether imported shape items
|
* @option options.expandShapes {Boolean} whether imported shape items
|
||||||
* should be expanded to path items.
|
* should be expanded to path items.
|
||||||
*
|
*
|
||||||
* @name Item#importSVG
|
|
||||||
* @function
|
|
||||||
* @param {SVGElement|String} svg the SVG content to import
|
* @param {SVGElement|String} svg the SVG content to import
|
||||||
* @param {Object} [options={ expandShapes: false }] the import options
|
* @param {Object} [options={ expandShapes: false }] the import options
|
||||||
* @return {Item} the imported Paper.js parent item
|
* @return {Item} the imported Paper.js parent item
|
||||||
|
|
|
@ -593,15 +593,14 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
|
||||||
* Exports (serializes) the project with all its layers and child items to
|
* Exports (serializes) the project with all its layers and child items to
|
||||||
* a JSON data string.
|
* a JSON data string.
|
||||||
*
|
*
|
||||||
* The options object offers control over some aspects of the JSON export:
|
* @name Project#exportJSON
|
||||||
|
* @function
|
||||||
*
|
*
|
||||||
* @option options.asString {Boolean} whether the JSON is returned as a
|
* @option options.asString {Boolean} whether the JSON is returned as a
|
||||||
* {@code Object} or a {@code String}.
|
* {@code Object} or a {@code String}.
|
||||||
* @option options.precision {Number} the amount of fractional digits in
|
* @option options.precision {Number} the amount of fractional digits in
|
||||||
* numbers used in JSON data.
|
* numbers used in JSON data.
|
||||||
*
|
*
|
||||||
* @name Project#exportJSON
|
|
||||||
* @function
|
|
||||||
* @param {Object} [options={ asString: true, precision: 5 }] the
|
* @param {Object} [options={ asString: true, precision: 5 }] the
|
||||||
* serialization options
|
* serialization options
|
||||||
* @return {String} the exported JSON data
|
* @return {String} the exported JSON data
|
||||||
|
@ -626,7 +625,8 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
|
||||||
* Exports the project with all its layers and child items as an SVG DOM,
|
* Exports the project with all its layers and child items as an SVG DOM,
|
||||||
* all contained in one top level SVG group node.
|
* all contained in one top level SVG group node.
|
||||||
*
|
*
|
||||||
* The options object offers control over some aspects of the SVG export:
|
* @name Project#exportSVG
|
||||||
|
* @function
|
||||||
*
|
*
|
||||||
* @option options.asString {Boolean} whether a SVG node or a {@code String}
|
* @option options.asString {Boolean} whether a SVG node or a {@code String}
|
||||||
* is to be returned.
|
* is to be returned.
|
||||||
|
@ -635,8 +635,6 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
|
||||||
* @option options.matchShapes {Boolean} whether path items should tried to
|
* @option options.matchShapes {Boolean} whether path items should tried to
|
||||||
* be converted to shape items, if their geometries can be made to match.
|
* be converted to shape items, if their geometries can be made to match.
|
||||||
*
|
*
|
||||||
* @name Project#exportSVG
|
|
||||||
* @function
|
|
||||||
* @param {Object} [options={ asString: false, precision: 5,
|
* @param {Object} [options={ asString: false, precision: 5,
|
||||||
* matchShapes: false }] the export options.
|
* matchShapes: false }] the export options.
|
||||||
* @return {SVGElement} the project converted to an SVG node
|
* @return {SVGElement} the project converted to an SVG node
|
||||||
|
@ -649,13 +647,12 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
|
||||||
* Note that the project is not cleared first. You can call
|
* Note that the project is not cleared first. You can call
|
||||||
* {@link Project#clear()} to do so.
|
* {@link Project#clear()} to do so.
|
||||||
*
|
*
|
||||||
* The options object offers control over some aspects of the SVG import:
|
* @name Project#importSVG
|
||||||
|
* @function
|
||||||
*
|
*
|
||||||
* @option options.expandShapes {Boolean} whether imported shape items
|
* @option options.expandShapes {Boolean} whether imported shape items
|
||||||
* should be expanded to path items.
|
* should be expanded to path items.
|
||||||
*
|
*
|
||||||
* @name Project#importSVG
|
|
||||||
* @function
|
|
||||||
* @param {SVGElement|String} svg the SVG content to import
|
* @param {SVGElement|String} svg the SVG content to import
|
||||||
* @param {Object} [options={ expandShapes: false }] the import options
|
* @param {Object} [options={ expandShapes: false }] the import options
|
||||||
* @return {Item} the imported Paper.js parent item
|
* @return {Item} the imported Paper.js parent item
|
||||||
|
|
Loading…
Reference in a new issue