• added method setWindow for work with iframes
[raphael] / README.markdown
index 5c18b75..dfdae3f 100644 (file)
@@ -132,7 +132,6 @@ Please refer to the [SVG specification](http://www.w3.org/TR/SVG/) for an explan
 
 * cx number
 * cy number
-* dasharray string \[“-”, “.”, “-.”, “-..”, “. ”, “- ”, “--”, “- .”, “--.”, “--..”\]
 * fill colour
 * fill-opacity number
 * font string
@@ -149,6 +148,7 @@ Please refer to the [SVG specification](http://www.w3.org/TR/SVG/) for an explan
 * ry number
 * scale CSV
 * stroke colour
+* stroke-dasharray string \[“-”, “.”, “-.”, “-..”, “. ”, “- ”, “--”, “- .”, “--.”, “--..”\]
 * stroke-linecap string \[“butt”, “square”, “round”, “miter”\]
 * stroke-linejoin string \[“butt”, “square”, “round”, “miter”\]
 * stroke-miterlimit number
@@ -171,10 +171,35 @@ Linearly changes an attribute from its current value to its specified value in t
 
 ##### Parameters
 
-1. newAttrs object A parameters object of the animation results.
+1. newAttrs object A parameters object of the animation results. (Not all attributes can be animated.)
 2. ms number The duration of the animation, given in milliseconds.
 3. callback function \[optional\]
 
+##### Attributes that can be animated
+
+The `newAttrs` parameter accepts an object whose properties are the attributes to animate. However, not all attributes listed in the `attr` method reference can be animated. The following is a list of those properties that can be animated:
+
+* cx number
+* cy number
+* fill colour
+* fill-opacity number
+* font-size number
+* height number
+* opacity number
+* path pathString
+* r number
+* rotation number
+* rx number
+* ry number
+* scale CSV
+* stroke colour
+* stroke-opacity number
+* stroke-width number
+* translation CSV
+* width number
+* x number
+* y number
+
 ##### Usage
 
     var c = paper.circle(10, 10, 10);
@@ -293,6 +318,20 @@ Embeds an image into the SVG/VML canvas.
 
     var c = paper.image("apple.png", 10, 10, 100, 100);
 
+#### text
+
+Draws a text string.
+
+##### Parameters
+
+1. x number X coordinate position
+2. y number Y coordinate position
+3. text string The text string to draw.
+
+##### Usage
+
+    var t = paper.text(10, 10, "Look mom, I'm scalable!");
+
 #### path
 
 Initialises path drawing. Typically, this function returns an empty `path` object and to draw paths you use its built-in methods like `lineTo` and `curveTo`. However, you can also specify a path literally by supplying the path data as a second argument.