From: Ulrich-Matthias Schäfer Date: Tue, 19 Jan 2016 21:57:47 +0000 (+0100) Subject: added `point()` to readme X-Git-Tag: 2.3.0~16 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ee027f30ffad52bdf0dbf3389cdc9c526118faf6;p=svg.js.git added `point()` to readme --- diff --git a/README.md b/README.md index 141b74f..e524467 100644 --- a/README.md +++ b/README.md @@ -1918,6 +1918,17 @@ path.matrixify() __`returns`: `SVG.Matrix`__ +### point() +Transforms a point from screen coordinates to the elements coordinate system + +```javascript +// e is some mouseevent +var point = path.point(e.screeX, e.screenY) // {x, y} +``` + +__`returns`: `SVG.Point`__ + + ### inside() To check if a given point is inside the bounding box of an element you can use the `inside()` method: