mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2024-12-29 09:22:22 -05:00
Docs: Add documentation for options.bound and options.matrix in #exportSVG()
Closes #1254
This commit is contained in:
parent
e354bccf69
commit
89a953dde0
2 changed files with 16 additions and 0 deletions
|
@ -2259,6 +2259,14 @@ new function() { // Injection scope for hit-test functions shared with project
|
|||
* @name Item#exportSVG
|
||||
* @function
|
||||
*
|
||||
* @option [options.bounds='view'] {String|Rectangle} the bounds of the area
|
||||
* to export, either as a string ({@values 'view', content'}), or a
|
||||
* {@link Rectangle} object: `'view'` uses the view bounds,
|
||||
* `'content'` uses the stroke bounds of all content
|
||||
* @option [options.matrix=paper.view.matrix] {Matrix} the matrix with which
|
||||
* to transform the exported content: If `options.bounds` is set to
|
||||
* `'view'`, `paper.view.matrix` is used, for all other settings of
|
||||
* `options.bounds` the identity matrix is used.
|
||||
* @option [options.asString=false] {Boolean} whether a SVG node or a
|
||||
* `String` is to be returned
|
||||
* @option [options.precision=5] {Number} the amount of fractional digits in
|
||||
|
|
|
@ -760,6 +760,14 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
|
|||
* @name Project#exportSVG
|
||||
* @function
|
||||
*
|
||||
* @option [options.bounds='view'] {String|Rectangle} the bounds of the area
|
||||
* to export, either as a string ({@values 'view', content'}), or a
|
||||
* {@link Rectangle} object: `'view'` uses the view bounds,
|
||||
* `'content'` uses the stroke bounds of all content
|
||||
* @option [options.matrix=paper.view.matrix] {Matrix} the matrix with which
|
||||
* to transform the exported content: If `options.bounds` is set to
|
||||
* `'view'`, `paper.view.matrix` is used, for all other settings of
|
||||
* `options.bounds` the identity matrix is used.
|
||||
* @option [options.asString=false] {Boolean} whether a SVG node or a
|
||||
* `String` is to be returned
|
||||
* @option [options.precision=5] {Number} the amount of fractional digits in
|
||||
|
|
Loading…
Reference in a new issue