summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwout <wout@impinc.co.uk>2014-02-01 14:43:06 +0100
committerwout <wout@impinc.co.uk>2014-02-01 14:43:06 +0100
commit3b5c16a1ab20d2e2b16c80f448aa5897f3ecb386 (patch)
tree382653e217a05943745af562f76374769155e079
parentf047e3c3aad7920df978a2dbc758a961112c9d43 (diff)
downloadsvg.js-3b5c16a1ab20d2e2b16c80f448aa5897f3ecb386.tar.gz
svg.js-3b5c16a1ab20d2e2b16c80f448aa5897f3ecb386.zip
Updated README
-rw-r--r--README.md34
1 files changed, 22 insertions, 12 deletions
diff --git a/README.md b/README.md
index c20c268..211d51f 100644
--- a/README.md
+++ b/README.md
@@ -561,6 +561,7 @@ var group = draw.group()
draw.index(rect) //-> returns 0
group.index(rect) //-> returns -1
```
+###### `returns`: a number equal to or higher than `0`, `-1` if not found
### get()
Get an element on a given position in the children array:
@@ -572,6 +573,15 @@ var circle = draw.circle(50)
draw.get(0) //-> returns rect
draw.get(1) //-> returns circle
```
+###### `returns`: an element
+
+### clear()
+To remove all elements from a parent element:
+
+```javascript
+draw.clear()
+```
+###### `returns`: itself
## Manipulating elements
@@ -856,24 +866,29 @@ This method also acts as a getter:
rect.height() //-> returns 325
```
-
-### hide(), show() and visible()
-We all love to have a little hide:
+### hide()
+Hide element:
```javascript
rect.hide()
```
+###### `returns`: itself
-and show:
+### show()
+Show element:
```javascript
rect.show()
```
+###### `returns`: itself
+### visible()
To check if the element is visible:
+
```javascript
rect.visible()
```
+###### `returns`: `true` or `false`
### clone()
To make an exact copy of an element the `clone()` method comes in handy:
@@ -881,23 +896,17 @@ To make an exact copy of an element the `clone()` method comes in handy:
```javascript
var clone = rect.clone()
```
+###### `returns`: a new element
This will create an new, unlinked copy. If you want to make a linked clone have a look at the [use](#elements/use) element.
-
### remove()
Pretty straightforward:
```javascript
rect.remove()
```
-
-### clear()
-To remove all elements from a parent element:
-
-```javascript
-draw.clear()
-```
+###### `returns`: itself
### replace()
This method will replace the called element with the given element in the same position in the stack:
@@ -905,6 +914,7 @@ This method will replace the called element with the given element in the same p
```javascript
rect.replace(draw.circle(100))
```
+###### `returns`: the element passed as argument
## Inserting elements