diff --git a/src/item/Item.js b/src/item/Item.js index c8ec2c2f..d31c15fd 100644 --- a/src/item/Item.js +++ b/src/item/Item.js @@ -692,30 +692,31 @@ var Item = this.Item = Base.extend(/** @lends Item# */{ * hit test and may contain a combination of the following values: * tolerance: {@code Number} - The tolerance of the hit test in * points. - * type: Only hit test again a certain item + * options.type: Only hit test again a certain item * type: {@link PathItem}, {@link Raster}, {@link TextItem}, etc. - * fill: {@code Boolean} - Hit test the fill of items. - * stroke: {@code Boolean} - Hit test the curves of path items, + * options.fill: {@code Boolean} - Hit test the fill of items. + * options.stroke: {@code Boolean} - Hit test the curves of path items, * taking into account stroke width. - * segment: {@code Boolean} - Hit test for {@link Segment#point} of + * options.segment: {@code Boolean} - Hit test for {@link Segment#point} of * {@link Path} items. - * handles: {@code Boolean} - Hit test for the handles + * options.handles: {@code Boolean} - Hit test for the handles * ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments. - * ends: {@code Boolean} - Only hit test for the first or last + * options.ends: {@code Boolean} - Only hit test for the first or last * segment points of open path items. - * bounds: {@code Boolean} - Hit test the corners and side-centers + * options.bounds: {@code Boolean} - Hit test the corners and side-centers * of the bounding rectangle of items ({@link Item#bounds}). - * center: {@code Boolean} - Hit test the {@link Rectangle#center} + * options.center: {@code Boolean} - Hit test the {@link Rectangle#center} * of the bounding rectangle of items ({@link Item#bounds}). - * guide: {@code Boolean} - Hit test items that have + * options.guide: {@code Boolean} - Hit test items that have * {@link Item#guide} set to {@code true}. - * selected: {@code Boolean} - Only hit selected items. + * options.selected: {@code Boolean} - Only hit selected items. * + * @name Item#hitTest + * @function * @param {Point} point The point where the hit test should be performed * @param {Object} [options={ fill: true, stroke: true, segments: true, * tolerance: 2 }] - * @param {Matrix} [matrix] - * @return {HitResult|null} A hit result object that contains more + * @return {HitResult} A hit result object that contains more * information about what exactly was hit or {@code null} if nothing was * hit. */