scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-08-12 22:18:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Switch from inline @option tags to real doc tags.

Browse source
This commit is contained in:
Jürg Lehni 2014-10-20 23:33:28 +02:00
parent c25548031b
commit 99ef521af4
7 changed files with 107 additions and 106 deletions
src/project
Project.js

80
src/project/Project.js
View file

@ -287,38 +287,38 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
},
/**
* Perform a hit test on the items contained within the project at the
* Perform a hit-test on the items contained within the project at the
* location of the specified point.
*
* The options object allows you to control the specifics of the hit test
* The options object allows you to control the specifics of the hit-test
* and may contain a combination of the following values:
*
* {@option options.tolerance:Number the tolerance of the hit test in
* @option options.tolerance {Number} the tolerance of the hit-test in
* points. Can also be controlled through
* {@link Project#options}{@code .hitTolerance}.}
* {@option options.class:{Function} Only hit test again a certain item
* class and its sub-classes: {@code Group, Layer, Path, CompoundPath,
* Shape, Raster, PlacedSymbol, PointText}, etc.}
* {@option options.fill:{Boolean} hit test the fill of items.}
* {@option options.stroke:{Boolean} hit test the stroke of path.}
* items, taking into account the setting of stroke color and width.}
* {@option options.segments:{Boolean} hit test for {@link Segment#point} of
* {@link Path} items.}
* {@option options.curves:{Boolean} hit test the curves of path items,
* without taking the stroke color or width into account.}
* {@option options.handles:{Boolean} hit test for the handles.}
* ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments.}
* {@option options.ends:{Boolean} only hit test for the first or
* last segment points of open path items.}
* {@option options.bounds:{Boolean} hit test the corners and
* side-centers of the bounding rectangle of items ({@link Item#bounds}).}
* {@option options.center:{Boolean} hit test the {@link Rectangle#center}
* of the bounding rectangle of items ({@link Item#bounds}).}
* {@option options.guides:{Boolean} hit test items that have
* {@link Item#guide} set to {@code true}.}
* {@option options.selected:{Boolean} only hit selected items.}
* {@link PaperScope#settings}{@code .hitTolerance}.
* @option options.class {Function} only hit-test again a certain item class
* and its sub-classes: {@code Group, Layer, Path, CompoundPath,
* Shape, Raster, PlacedSymbol, PointText}, etc.
* @option options.fill {Boolean} hit-test the fill of items.
* @option options.stroke {Boolean} hit-test the stroke of path items,
* taking into account the setting of stroke color and width.
* @option options.segments {Boolean} hit-test for {@link Segment#point} of
* {@link Path} items.
* @option options.curves {Boolean} hit-test the curves of path items,
* without taking the stroke color or width into account.
* @option options.handles {Boolean} hit-test for the handles.
* ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments.
* @option options.ends {Boolean} only hit-test for the first or last
* segment points of open path items.
* @option options.bounds {Boolean} hit-test the corners and side-centers of
* the bounding rectangle of items ({@link Item#bounds}).
* @option options.center {Boolean} hit-test the {@link Rectangle#center} of
* the bounding rectangle of items ({@link Item#bounds}).
* @option options.guides {Boolean} hit-test items that have
* {@link Item#guide} set to {@code true}.
* @option options.selected {Boolean} only hit selected items.
*
* @param {Point} point the point where the hit test should be performed
* @param {Point} point the point where the hit-test should be performed
* @param {Object} [options={ fill: true, stroke: true, segments: true,
* tolerance: true }]
* @return {HitResult} a hit result object that contains more
@ -584,14 +584,12 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
* 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:
* The options object offers control over some aspects of the JSON export:
*
* {@option options.asString:{Boolean} whether a SVG node or a {@code String}
* is to be returned.}
* {@option options.precision:{Number} the amount of fractional digits in
* numbers used in SVG data.}
* {@option options.matchShapes:{Boolean} whether imported path items should
* tried to be converted to shape items, if their geometries match.}
* @option options.asString {Boolean} whether the JSON is returned as a
* {@code Object} or a {@code String}.
* @option options.precision {Number} the amount of fractional digits in
* numbers used in JSON data.
*
* @name Project#exportJSON
* @function
@ -621,12 +619,12 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
*
* The options object offers control over some aspects of the SVG export:
*
* {@option options.asString:{Boolean} whether a SVG node or a
* {@code String} is to be returned.}
* {@option options.precision:{Number} the amount of fractional digits in
* numbers used in SVG data.}
* {@option options.matchShapes:{Boolean} whether path items should tried to
* be converted to shape items, if their geometries can be made to match.}
* @option options.asString {Boolean} whether a SVG node or a {@code String}
* is to be returned.
* @option options.precision {Number} the amount of fractional digits in
* numbers used in SVG data.
* @option options.matchShapes {Boolean} whether path items should tried to
* be converted to shape items, if their geometries can be made to match.
*
* @name Project#exportSVG
* @function
@ -644,8 +642,8 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
*
* The options object offers control over some aspects of the SVG import:
*
* {@option options.expandShapes:{Boolean} whether imported shape
* items should be expanded to path items.}
* @option options.expandShapes {Boolean} whether imported shape items
* should be expanded to path items.
*
* @name Project#importSVG
* @function