]> source.dussan.org Git - svg.js.git/commitdiff
added `point()` to readme
authorUlrich-Matthias Schäfer <ulima.ums@googlemail.com>
Tue, 19 Jan 2016 21:57:47 +0000 (22:57 +0100)
committerUlrich-Matthias Schäfer <ulima.ums@googlemail.com>
Tue, 19 Jan 2016 21:57:47 +0000 (22:57 +0100)
README.md

index 141b74fde9131ec93fc4da3b7baf2a11880fffb3..e52446732e9f195c6cc27493c24e4933f28eb151 100644 (file)
--- 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: