aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorwout <wout@impinc.co.uk>2013-03-12 13:31:09 +0100
committerwout <wout@impinc.co.uk>2013-03-12 13:31:09 +0100
commit4bd21ec64a0e3c1d4d0acf5685b2230285c7c16b (patch)
tree0300a47ca1b263ae0cd0fdb5fe76218ceb9aa745 /README.md
parent6c6c82ed59533f44f8754b69d47e3b11cd6dd129 (diff)
downloadsvg.js-4bd21ec64a0e3c1d4d0acf5685b2230285c7c16b.tar.gz
svg.js-4bd21ec64a0e3c1d4d0acf5685b2230285c7c16b.zip
Added x(), y(), cx(), cy() and matrix
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 39 insertions, 14 deletions
diff --git a/README.md b/README.md
index 5092b1b..007f1e5 100644
--- a/README.md
+++ b/README.md
@@ -234,24 +234,39 @@ rect.transform({
})
```
+You can also provide two arguments as property and value:
+
+```javascript
+rect.transform('matrix', '1,0.5,0.5,1,0,0')
+```
+
All available transformations are:
```javascript
rect.transform({
x: [translation on x-axis]
, y: [translation on y-axis]
+
, rotation: [degrees]
, cx: [x rotation point]
, cy: [y rotation point]
+
, scaleX: [scaling on x-axis]
, scaleX: [scaling on y-axis]
+
, skewX: [skewing on x-axis]
, skewY: [skewing on y-axis]
+
+, matrix: [a 6-digit matrix string; e.g. '1,0,0,1,0,0']
+, a: [the first matrix digit]
+, b: [the second matrix digit]
+, c: [the third matrix digit]
+, d: [the fourth matrix digit]
+, e: [the fifth matrix digit]
+, f: [the sixth matrix digit]
})
```
-Important: matrix transformations are not yet supported.
-
### Style
With the `style()` method the `style` attribute can be managed like attributes with `attr`:
@@ -294,6 +309,12 @@ Move the element to a given `x` and `y` position by its upper left corner:
rect.move(200, 350)
```
+This will have the same effect as:
+
+```javascript
+rect.x(200).y(350)
+```
+
Note that you can also use the following code to move elements around:
```javascript
@@ -302,24 +323,28 @@ rect.attr({ x: 20, y: 60 })
Although `move()` is much more convenient because it will always use the upper left corner as the position reference, whereas with using `attr()` the `x` and `y` reference differ between element types. For example, rect uses the upper left corner with the `x` and `y` attributes, circle and ellipse use their center with the `cx` and `cy` attributes and thereby simply ignoring the `x` and `y` values you might assign.
-
-### Size
-Set the size of an element by a given `width` and `height`:
+### Center
+This is an extra method to move an element by its center:
```javascript
-rect.size(200, 300)
+rect.center(150, 150)
```
-Same as with `move()` the size of an element could be set by using `attr()`. But because every type of element is handles its size differently the `size()` method is much more convenient.
+This will have the same effect as:
+```javascript
+rect.cx(150).cy(150)
+```
-### Center
-This is an extra method to move an element by its center:
+### Size
+Set the size of an element by a given `width` and `height`:
```javascript
-rect.center(150, 150)
+rect.size(200, 300)
```
+Same as with `move()` the size of an element could be set by using `attr()`. But because every type of element is handles its size differently the `size()` method is much more convenient.
+
### Hide and show
We all love to have a little hide:
@@ -431,24 +456,24 @@ Of course `attr()`:
rect.animate().attr({ fill: '#f03' })
```
-The `move()` method:
+The `x()`, `y()` and `move()` methods:
```javascript
rect.animate().move(100, 100)
```
-And the `center()` method:
+And the `cx()`, `cy()` and `center()` methods:
```javascript
rect.animate().center(200, 200)
```
-If you include the sugar.js module, `rotate()` and `skew()` will be available as well:
+If you include the sugar.js module, `fill()`, `stroke()`, `rotate()`, `skew()`, `scale()`, `matrix()` and `opacity()` will be available as well:
```javascript
rect.animate().rotate(45).skew(25, 0)
```
You can also animate non-numeric unit values unsing the `attr()` method:
```javascript
-rect.attr('x', '10%').animate().attr('x', '50%')
+rect.animate().attr('x', '10%').animate().attr('x', '50%')
```
### Stopping animations