git.roojs.org Git - raphael/blob - reference.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3     <head>
   4         <title>Raphaël Reference</title>
   5         <meta http-equiv="content-language" content="en">
   6         <meta charset="utf-8">
   7         <meta name="author" content="Dmitry Baranovskiy">
   8         <meta name="description" content="Vector Graphics JavaScript Library">
   9         <meta name="keywords" content="JavaScript Library, Raphael, SVG, VML">
  10         <meta name="viewport" content="width=450; user-scalable=no">
  11         <link rel="apple-touch-icon-precomposed" href="/Raphael.png"/>
  12         <link rel="shortcut icon" href="/favicon16.png" type="image/x-icon">
  13         <link rel="stylesheet" href="site.css" type="text/css">
  14         <link rel="shortcut icon" href="/favicon16.png" type="image/x-icon">
  15     </head>
  16     <body class="raphael" id="reference">
  17         <div id="header">
  18             <h1><span>&nbsp;</span>Raphaël—JavaScript Library</h1>
  19         </div>
  20         <div id="content">
  21             <div id="top">&nbsp;</div>
  22                     <div id="column-1">
  23                         <h2>Main Function</h2>
  24                         <h3 id="RAPHAEL">
  25                             Raphael
  26                         </h3>
  27                         <p>
  28                             Creates a canvas object on which to draw. You must do this first, as all future calls to drawing methods from this instance will be bound to this canvas.
  29                         </p>
  30                         <h4>Parameters</h4>
  31                         <ol>
  32                             <li>container <em>HTMLElement</em> or <em>string</em></li>
  33                             <li>width <em>number</em></li>
  34                             <li>height <em>number</em></li>
  35                         </ol>
  36                         <p>or</p>
  37                         <ol>
  38                             <li>x <em>number</em></li>
  39                             <li>y <em>number</em></li>
  40                             <li>width <em>number</em></li>
  41                             <li>height <em>number</em></li>
  42                         </ol>
  43                         <p>or</p>
  44                         <ol>
  45                             <li>all <em>array</em> (first 3 or 4 elements in the array are equal to [containerID, width, height] or [x, y, width, height]. The rest are element descriptions in format {type: type, &lt;attributes>})</li>
  46                         </ol>
  47                         <h4>Usage</h4>
  48                         <pre class="javascript code"><code>// Each of the following examples create a canvas that is 320px wide by 200px high
  49 // Canvas is created at the viewport’s 10,50 coordinate
  50 var paper = Raphael(10, 50, 320, 200);
  51 // Canvas is created at the top left corner of the #notepad element
  52 // (or its top right corner in dir="rtl" elements)
  53 var paper = Raphael(document.getElementById("notepad"), 320, 200);
  54 // Same as above
  55 var paper = Raphael("notepad", 320, 200);
  56 // Image dump
  57 var set = Raphael(["notepad", 320, 200, {
  58     type: "rect",
  59     x: 10,
  60     y: 10,
  61     width: 25,
  62     height: 25,
  63     stroke: "#f00"
  64 }, {
  65     type: "text",
  66     x: 30,
  67     y: 40,
  68     text: "Dump"
  69 }]);</code></pre>
  70                         <h3 id="circle">
  71                             circle
  72                         </h3>
  73                         <div class="sample" id="circle-sample"></div>
  74                         <p>
  75                             Draws a circle.
  76                         </p>
  77                         <h4>Parameters</h4>
  78                         <ol>
  79                             <li>x <em>number</em> X coordinate of the centre</li>
  80                             <li>y <em>number</em> Y coordinate of the centre</li>
  81                             <li>r <em>number</em> radius</li>
  82                         </ol>
  83                         <h4>Usage</h4>
  84                         <pre class="javascript code"><code>var c = paper.circle(50, 50, 40);</code></pre>
  85                         <h3 id="rect">
  86                             rect
  87                         </h3>
  88                         <div class="sample" id="rect-sample"></div>
  89                         <p>
  90                             Draws a rectangle.
  91                         </p>
  92                         <h4>Parameters</h4>
  93                         <ol>
  94                             <li>x <em>number</em> X coordinate of top left corner</li>
  95                             <li>y <em>number</em> Y coordinate of top left corner</li>
  96                             <li>width <em>number</em></li>
  97                             <li>height <em>number</em></li>
  98                             <li>r <em>number</em> [optional] radius for rounded corners, default is 0</li>
  99                         </ol>
 100                         <h4>Usage</h4>
 101                         <pre class="javascript code"><code>// regular rectangle</code>
 102 <code>var c = paper.rect(10, 10, 50, 50);</code>
 103 <code>// rectangle with rounded corners</code>
 104 <code>var c = paper.rect(40, 40, 50, 50, 10);</code></pre>
 105                         <h3 id="ellipse">
 106                             ellipse
 107                         </h3>
 108                         <div class="sample" id="ellipse-sample"></div>
 109                         <p>
 110                             Draws an ellipse.
 111                         </p>
 112                         <h4>Parameters</h4>
 113                         <ol>
 114                             <li>x <em>number</em> X coordinate of the centre</li>
 115                             <li>y <em>number</em> X coordinate of the centre</li>
 116                             <li>rx <em>number</em> Horisontal radius</li>
 117                             <li>ry <em>number</em> Vertical radius</li>
 118                         </ol>
 119                         <h4>Usage</h4>
 120                         <pre class="javascript code"><code>var c = paper.ellipse(50, 50, 40, 20);</code></pre>
 121                         <h3 id="image">
 122                             image
 123                         </h3>
 124                         <div class="sample" id="image-sample"></div>
 125                         <p>
 126                             Embeds an image into the SVG/VML canvas.
 127                         </p>
 128                         <h4>Parameters</h4>
 129                         <ol>
 130                             <li>src <em>string</em> URI of the source image</li>
 131                             <li>x <em>number</em> X coordinate position</li>
 132                             <li>y <em>number</em> Y coordinate position</li>
 133                             <li>width <em>number</em> Width of the image</li>
 134                             <li>height <em>number</em> Height of the image</li>
 135                         </ol>
 136                         <h4>Usage</h4>
 137                         <pre class="javascript code"><code>var c = paper.image("apple.png", 10, 10, 80, 80);</code></pre>
 138                         <h3 id="set">
 139                             set
 140                         </h3>
 141                         <div class="sample" id="set-sample"></div>
 142                         <p>
 143                             Creates array-like object to keep and operate couple of elements at once. Warning: it doesn’t create any elements for itself in the page.
 144                         </p>
 145                         <h4>Usage</h4>
 146                         <pre class="javascript code"><code>var st = paper.set();</code>
 147 <code>st.push(
 148     paper.circle(10, 10, 5),
 149     paper.circle(30, 10, 5)
 150 );</code>
 151 <code>st.attr({fill: "red"});</code></pre>
 152                         <h3 id="text">
 153                             text
 154                         </h3>
 155                         <div class="sample" id="text-sample"></div>
 156                         <p>
 157                             Draws a text string. If you need line breaks, put “\n” in the string.
 158                         </p>
 159                         <h4>Parameters</h4>
 160                         <ol>
 161                             <li>x <em>number</em> X coordinate position.</li>
 162                             <li>y <em>number</em> Y coordinate position.</li>
 163                             <li>text <em>string</em> The text string to draw.</li>
 164                         </ol>
 165                         <h4>Usage</h4>
 166                         <pre class="javascript code"><code>var t = paper.text(50, 50, "Raphaël\nkicks\nbutt!");</code></pre>
 167                         <h3 id="path">
 168                             path
 169                         </h3>
 170                         <div class="sample" id="path-sample"></div>
 171                         <p>
 172                             Creates a path element by given path data string.
 173                         </p>
 174                         <h4>Parameters</h4>
 175                         <ol>
 176                             <li>pathString <em>string</em> [optional] Path data in <a href="http://www.w3.org/TR/SVG/paths.html#PathData" title="Details of a path's data attribute's format are described in the SVG specification.">SVG path string format</a>.</li>
 177                         </ol>
 178                         <h4>Usage</h4>
 179                         <pre class="javascript code"><code>var c = paper.path("M10 10L90 90");
 180 // draw a diagonal line:
 181 // move to 10,10, line to 90,90</code></pre>
 182                         <h3 id="clear">
 183                             clear
 184                         </h3>
 185                         <p>
 186                             Clears the canvas, i.e. removes all the elements.
 187                         </p>
 188                         <h4>Usage</h4>
 189                         <pre class="javascript code"><code>var c = paper.path("M10 10L90 90");
 190 paper.clear();</code></pre>
 191                         <h2 id="Element">
 192                             Element’s generic methods
 193                         </h2>
 194                         <p>
 195                             Each object created on the canvas shares these same generic methods:
 196                         </p>
 197                         <h3 id="node">
 198                             node
 199                         </h3>
 200                         <p>
 201                             Gives you a reference to the DOM object, so you can assign event handlers or just mess around.
 202                         </p>
 203                         <h4>Usage</h4>
 204                         <pre class="javascript code"><code>// draw a circle at coordinate 10,10 with radius of 10
 205 var c = paper.circle(10, 10, 10);
 206 c.node.onclick = function () {
 207     c.attr("fill", "red");
 208 };</code></pre>
 209                         <h3 id="paper">
 210                             paper
 211                         </h3>
 212                         <p>
 213                             Internal reference to “paper” where object drawn. Mainly for use in plugins and element extensions.
 214                         </p>
 215                         <h4>Usage</h4>
 216                         <pre class="javascript code"><code>Raphael.el.cross = function () {
 217     this.attr({fill: "red"});
 218     this.paper.path("M10,10L50,50M50,10L10,50")
 219         .attr({stroke: "red"});
 220 }</code></pre>
 221                         <h3 id="remove">
 222                             remove
 223                         </h3>
 224                         <p>
 225                             Removes element from the DOM. You can’t use it after this method call.
 226                         </p>
 227                         <h4>Usage</h4>
 228                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 229 c.remove();</code></pre>
 230                         <h3 id="hide">
 231                             hide
 232                         </h3>
 233                         <p>
 234                             Makes element invisible.
 235                         </p>
 236                         <h4>Usage</h4>
 237                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 238 c.hide();</code></pre>
 239                         <h3 id="show">
 240                             show
 241                         </h3>
 242                         <p>
 243                             Makes element visible.
 244                         </p>
 245                         <h4>Usage</h4>
 246                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 247 c.show();</code></pre>
 248                         <h3 id="rotate">
 249                             rotate
 250                         </h3>
 251                         <p>
 252                             Rotates the element by the given degree from its center point.
 253                         </p>
 254                         <h4>Parameters</h4>
 255                         <ol>
 256                             <li>degree <em>number</em> Degree of rotation (0 – 360°)</li>
 257                             <li>isAbsolute <em>boolean</em> [optional] Specifies is degree is relative to previous position (<code>false</code>) or is it absolute angle (<code>true</code>)</li>
 258                         </ol>
 259                         <p>or</p>
 260                         <ol>
 261                             <li>degree <em>number</em> Degree of rotation (0 – 360°)</li>
 262                             <li>cx <em>number</em> [optional] X coordinate of the origin of rotation</li>
 263                             <li>cY <em>number</em> [optional] Y coordinate of the origin of rotation</li>
 264                         </ol>
 265                         <h4>Usage</h4>
 266                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 267 c.rotate(45);        // rotation is relative
 268 c.rotate(45, true);  // rotation is absolute</code></pre>
 269                         <h3 id="translate">
 270                             translate
 271                         </h3>
 272                         <p>
 273                             Moves the element around the canvas by the given distances.
 274                         </p>
 275                         <h4>Parameters</h4>
 276                         <ol>
 277                             <li>dx <em>number</em> Pixels of translation by X axis</li>
 278                             <li>dy <em>number</em> Pixels of translation by Y axis</li>
 279                         </ol>
 280                         <h4>Usage</h4>
 281                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 282 // moves the circle 10&nbsp;px to the right and down
 283 c.translate(10, 10);</code></pre>
 284                         <h3 id="scale">
 285                             scale
 286                         </h3>
 287                         <p>
 288                             Resizes the element by the given multiplier.
 289                         </p>
 290                         <h4>Parameters</h4>
 291                         <ol>
 292                             <li>Xtimes <em>number</em> Amount to scale horizontally</li>
 293                             <li>Ytimes <em>number</em> Amount to scale vertically</li>
 294                             <li>centerX <em>number</em> [optional] X of the center of scaling, default is the center of the element</li>
 295                             <li>centerY <em>number</em> [optional] Y of the center of scaling, default is the center of the element</li>
 296                         </ol>
 297                         <h4>Usage</h4>
 298                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 299 // makes the circle 1.5 times larger
 300 c.scale(1.5, 1.5);
 301 // makes the circle half as wide, and 75% as high
 302 c.scale(.5, .75);</code></pre>
 303                         <h3 id="attr">
 304                             attr
 305                         </h3>
 306                         <p>
 307                             Sets the attributes of elements directly.
 308                         </p>
 309                         <h4>Parameters</h4>
 310                         <ol>
 311                             <li>attributeName <em>string</em></li>
 312                             <li>value <em>string</em></li>
 313                         </ol>
 314                         <p>or</p>
 315                         <ol>
 316                             <li>params <em>object</em></li>
 317                         </ol>
 318                         <p>or</p>
 319                         <ol>
 320                             <li>attributeName <em>string</em> in this case method returns current value for given attribute name</li>
 321                         </ol>
 322                         <p>or</p>
 323                         <ol>
 324                             <li>attributeNames <em>array</em> in this case method returns array of current values for given attribute names</li>
 325                         </ol>
 326                         <p>or</p>
 327                         <p>no parameters, in this case object containing all attributes will be returned</p>
 328                         <h4>Possible parameters</h4>
 329                         <p>Please refer to the <a href="http://www.w3.org/TR/SVG/" title="The W3C Recommendation for the SVG language describes these properties in detail.">SVG specification</a> for an explanation of these parameters.</p>
 330                         <ul>
 331                             <li id="attr-clip-rect">clip-rect <em>string</em> comma or space separated values: x, y, width and height</li>
 332                             <li id="attr-cx">cx <em>number</em></li>
 333                             <li id="attr-cy">cy <em>number</em></li>
 334                             <li id="attr-fill">
 335                                 fill <em>colour</em> or <em>gradient</em>
 336                                 <ul>
 337                                     <li>linear gradient: “‹angle›-‹colour›[-‹colour›[:‹offset›]]*-‹colour›”, example: “<samp>90-#fff-#000</samp>” – 90° gradient from white to black or “<samp>0-#fff-#f00:20-#000</samp>” – 0° gradient from white via red (at 20%) to black</li>
 338                                     <li>radial gradient: “r[(‹fx›, ‹fy›)]‹colour›[-‹colour›[:‹offset›]]*-‹colour›”, example: “<samp>r#fff-#000</samp>” – gradient from white to black or “<samp>r(0.25, 0.75)#fff-#000</samp>” – gradient from white to black with focus point at 0.25, 0.75</li>
 339                                     <li>Focus point coordinates are in 0..1 range</li>
 340                                     <li>Radial gradients can only be applied to circles and ellipses</li>
 341                                 </ul>
 342                             </li>
 343                             <li id="attr-fill-opacity">fill-opacity <em>number</em></li>
 344                             <li id="attr-font">font <em>string</em></li>
 345                             <li id="attr-font-family">font-family <em>string</em></li>
 346                             <li id="attr-font-size">font-size <em>number</em></li>
 347                             <li id="attr-font-weight">font-weight <em>string</em></li>
 348                             <li id="attr-height">height <em>number</em></li>
 349                             <li id="attr-opacity">opacity <em>number</em></li>
 350                             <li id="attr-path">path <em>pathString</em> <a href="http://www.w3.org/TR/SVG/paths.html#PathData" title="Details of a path’s data attribute’s format are described in the SVG specification.">SVG path string format</a></li>
 351                             <li id="attr-r">r <em>number</em></li>
 352                             <li id="attr-rotation">rotation <em>number</em></li>
 353                             <li id="attr-rx">rx <em>number</em></li>
 354                             <li id="attr-ry">ry <em>number</em></li>
 355                             <li id="attr-scale">scale <em>string</em> comma or space separated values: xtimes, ytimes, cx, cy. See: <a href="#scale">scale</a></li>
 356                             <li id="attr-src">src <em>string</em> (URL)</li>
 357                             <li id="attr-stroke">stroke <em>colour</em></li>
 358                             <li id="attr-stroke-dasharray">stroke-dasharray <em>string</em> [“”, “<samp>-</samp>”, “<samp>.</samp>”, “<samp>-.</samp>”, “<samp>-..</samp>”, “<samp>. </samp>”, “<samp>- </samp>”, “<samp>--</samp>”, “<samp>-&nbsp;.</samp>”, “<samp>--.</samp>”, “<samp>--..</samp>”]</li>
 359                             <li id="attr-stroke-linecap">stroke-linecap <em>string</em> [“<samp>butt</samp>”, “<samp>square</samp>”, “<samp>round</samp>”]</li>
 360                             <li id="attr-stroke-linejoin">stroke-linejoin <em>string</em> [“<samp>bevel</samp>”, “<samp>round</samp>”, “<samp>miter</samp>”]</li>
 361                             <li id="attr-stroke-miterlimit">stroke-miterlimit <em>number</em></li>
 362                             <li id="attr-stroke-opacity">stroke-opacity <em>number</em></li>
 363                             <li id="attr-stroke-width">stroke-width <em>number</em></li>
 364                             <li id="attr-translation">translation <em>string</em> comma or space separated values: x and y</li>
 365                             <li id="attr-width">width <em>number</em></li>
 366                             <li id="attr-x">x <em>number</em></li>
 367                             <li id="attr-y">y <em>number</em></li>
 368                         </ul>
 369                         <h4>Usage</h4>
 370                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 371 // using strings
 372 c.attr("fill", "black");
 373 // using params object
 374 c.attr({fill: "#000", stroke: "#f00", opacity: 0.5});
 375 c.attr({
 376     fill: "90-#fff-#000",
 377     "stroke-dasharray": "-..",
 378     "clip-rect": "10, 10, 100, 100"
 379 });</code></pre>
 380                         <h3 id="animate">
 381                             animate
 382                         </h3>
 383                         <p>
 384                             Changes an attribute from its current value to its specified value in the given amount of milliseconds.
 385                         </p>
 386                         <h4>Parameters</h4>
 387                         <ol>
 388                             <li>newAttrs <em>object</em> A parameters object of the animation results. (Not all attributes can be animated.)</li>
 389                             <li>ms <em>number</em> The duration of the animation, given in milliseconds.</li>
 390                             <li>callback <em>function</em> [optional]</li>
 391                         </ol>
 392                         <p>or</p>
 393                         <ol>
 394                             <li>newAttrs <em>object</em> A parameters object of the animation results. (Not all attributes can be animated.)</li>
 395                             <li>ms <em>number</em> The duration of the animation, given in milliseconds.</li>
 396                             <li>easing <em>string</em> [“<samp>></samp>”, “<samp>&lt;</samp>”, “<samp>&lt;></samp>”, “<samp>backIn</samp>”, “<samp>backOut</samp>”, “<samp>bounce</samp>”, “<samp>elastic</samp>”, “<samp>cubic-bezier(p1, p2, p3, p4)</samp>”] or <em>function</em> [optional], see <a href="http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag" title="CSS Transitions Module Level 3">explanation re cubic-bezier syntax</a></li>
 397                             <li>callback <em>function</em> [optional]</li>
 398                         </ol>
 399                         <p>or</p>
 400                         <ol>
 401                             <li>keyFrames <em>object</em> Key-value map, where key represents keyframe timing: [“from”, “20%”, “to”, “35%”, etc] and value is the same as <code>newAttrs</code> from above, except it could also have <samp>easing</samp> and <samp>callback</samp> properties</li>
 402                             <li>ms <em>number</em> The duration of the animation, given in milliseconds.</li>
 403                         </ol>
 404                         <p>Look at the <a href="bounce.html">example of keyframes usage</a></p>
 405                         <h4>Attributes that can be animated</h4>
 406                         <p>The <code>newAttrs</code> parameter accepts an object whose properties are the attributes to animate. However, not all attributes listed in the <code>attr</code> method reference can be animated. The following is a list of those properties that can be animated:</p>
 407                         <ul>
 408                             <li>clip-rect <em>string</em></li>
 409                             <li>cx <em>number</em></li>
 410                             <li>cy <em>number</em></li>
 411                             <li>fill <em>colour</em></li>
 412                             <li>fill-opacity <em>number</em></li>
 413                             <li>font-size <em>number</em></li>
 414                             <li>height <em>number</em></li>
 415                             <li>opacity <em>number</em></li>
 416                             <li>path <em>pathString</em></li>
 417                             <li>r <em>number</em></li>
 418                             <li>rotation <em>string</em></li>
 419                             <li>rx <em>number</em></li>
 420                             <li>ry <em>number</em></li>
 421                             <li>scale <em>string</em></li>
 422                             <li>stroke <em>colour</em></li>
 423                             <li>stroke-opacity <em>number</em></li>
 424                             <li>stroke-width <em>number</em></li>
 425                             <li>translation <em>string</em></li>
 426                             <li>width <em>number</em></li>
 427                             <li>x <em>number</em></li>
 428                             <li>y <em>number</em></li>
 429                         </ul>
 430                         <h4>Easing</h4>
 431                         <p>
 432                             For easing use built in functions or add your own by adding new functions to <code>Raphael.easing_formulas</code> object. Look at the <a href="easing.html">example of easing usage</a>.
 433                         </p>
 434                         <h4>Usage</h4>
 435                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
 436 c.animate({cx: 20, r: 20}, 2000);
 437 c.animate({cx: 20, r: 20}, 2000, "bounce");
 438 c.animate({
 439     "20%": {cx: 20, r: 20, easing: ">"},
 440     "50%": {cx: 70, r: 120, callback: function () {…}},
 441     "100%": {cx: 10, r: 10}
 442 }, 2000);</code></pre>
 443                         <h3 id="animateWith">
 444                             animateWith
 445                         </h3>
 446                         <p>
 447                             The same as <a href="#animate"><code>animate</code></a> method, but synchronise animation with another element.
 448                         </p>
 449                         <h4>Parameters</h4>
 450                         <p>The same as for <a href="#animate"><code>animate</code></a> method, but first argument is an element.</p>
 451                         <h4>Usage</h4>
 452                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10),
 453     r = paper.rect(10, 10, 10, 10);
 454 c.animate({cx: 20, r: 20}, 2000);
 455 r.animateWith(c, {x: 20}, 2000);</code></pre>
 456                         <h3 id="animateAlong">
 457                             animateAlong
 458                         </h3>
 459                         <div class="sample" id="along-sample"></div>
 460                         <p>
 461                             Animates element along the given path. As an option it could rotate element along the path.
 462                         </p>
 463                         <h4>Parameters</h4>
 464                         <ol>
 465                             <li>path <em>object</em> or <em>string</em> path element or path string along which the element will be animated</li>
 466                             <li>ms <em>number</em> The duration of the animation, given in milliseconds.</li>
 467                             <li>rotate <em>boolean</em> [optional] if true, element will be rotated along the path</li>
 468                             <li>callback <em>function</em> [optional]</li>
 469                         </ol>
 470                         <h4>Usage</h4>
 471                         <pre class="javascript code"><code>var p = r.path("M100,100c0,50 100-50 100,0c0,50 -100-50 -100,0z").attr({stroke: "#ddd"}),
 472     e = r.ellipse(104, 100, 4, 4).attr({stroke: "none", fill: "#f00"}),
 473     b = r.rect(0, 0, 620, 400).attr({stroke: "none", fill: "#000", opacity: 0}).click(function () {
 474         e.attr({rx: 5, ry: 3}).animateAlong(p, 4000, true, function () {
 475             e.attr({rx: 4, ry: 4});
 476         });
 477     });</code></pre>
 478                         <h3 id="animateAlongBack">
 479                             animateAlongBack
 480                         </h3>
 481                         <p>
 482                             Similar to <a href="animateAlong"><code>animateAlong</code></a>. Animates element along the given path, starting from the end of it.
 483                         </p>
 484                         <h3 id="onAnimation">
 485                             onAnimation
 486                         </h3>
 487                         <div class="sample" id="onanim-sample"></div>
 488                         <p>
 489                             Sets or resets the function that will be called on each stage of the animation.
 490                         </p>
 491                         <h4>Parameters</h4>
 492                         <ol>
 493                             <li>f <em>function</em> function that will be called on each stage of animation</li>
 494                         </ol>
 495                         <h4>Usage</h4>
 496                         <pre class="javascript code"><code>var p = r.path("M10,50c0,50,80-50,80,0c0,50-80-50-80,0z"),
 497     p2 = r.path(),
 498     e = r.ellipse(10, 50, 4, 4).attr({stroke: "none", fill: "#f00"}).onAnimation(function () {
 499         p2.attr({path: "M50,10L" + e.attr("cx") + "," + e.attr("cy")});
 500     }),
 501     b = r.rect(0, 0, 620, 400).attr({stroke: "none", fill: "#000", opacity: 0}).click(function () {
 502         e.attr({rx: 5, ry: 3}).animateAlong(p, 4000, true, function () {
 503             e.attr({rx: 4, ry: 4});
 504         });
 505     });</code></pre>
 506                         <h3 id="getBBox">
 507                             getBBox
 508                         </h3>
 509                         <p>
 510                             Returns the dimensions of an element.
 511                         </p>
 512                         <h4>Usage</h4>
 513                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
 514 <code>var width = c.getBBox().width;</code></pre>
 515                         <h3 id="toFront">
 516                             toFront
 517                         </h3>
 518                         <p>
 519                             Moves the element so it is the closest to the viewer’s eyes, on top of other elements.
 520                         </p>
 521                         <h4>Usage</h4>
 522                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
 523 <code>c.toFront();</code></pre>
 524                         <h3 id="toBack">
 525                             toBack
 526                         </h3>
 527                         <p>
 528                             Moves the element so it is the furthest from the viewer’s eyes, behind other elements.
 529                         </p>
 530                         <h4>Usage</h4>
 531                         <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
 532 <code>c.toBack();</code></pre>
 533                         <h3 id="insertBefore">
 534                             insertBefore
 535                         </h3>
 536                         <p>
 537                             Inserts current object before the given one.
 538                         </p>
 539                         <h4>Usage</h4>
 540                         <pre class="javascript code"><code>var r = paper.rect(10, 10, 10, 10);</code>
 541 <code>var c = paper.circle(10, 10, 10);</code>
 542 <code>c.insertBefore(r);</code></pre>
 543                         <h3 id="insertAfter">
 544                             insertAfter
 545                         </h3>
 546                         <p>
 547                             Inserts current object after the given one.
 548                         </p>
 549                         <h4>Usage</h4>
 550                         <pre class="javascript code"><code>var r = paper.rect(10, 10, 10, 10);
 551 var c = paper.circle(10, 10, 10);
 552 r.insertAfter(c);</code></pre>
 553                         <h3 id="clone">
 554                             clone
 555                         </h3>
 556                         <p>
 557                             Returns a clone of the current element.
 558                         </p>
 559                         <h4>Usage</h4>
 560                         <pre class="javascript code"><code>var r = paper.rect(10, 10, 10, 10);
 561 var c = r.clone();</code></pre>
 562                         <h2>Graphic Primitives</h2>
 563                         <p>
 564                             Methods of “paper” object, created with <code>Raphael</code> function call.
 565                         </p>
 566                         <h3 id="raphael">
 567                             raphael
 568                         </h3>
 569                         <p>
 570                             Internal reference to <code>Raphael</code> object. In case it is not available.
 571                         </p>
 572                         <h4>Usage</h4>
 573                         <pre class="javascript code"><code>Raphael.el.red = function () {
 574     var hsb = this.paper.raphael.rgb2hsb(this.attr("fill"));
 575     hsb.h = 1;
 576     this.attr({fill: this.paper.raphael.hsb2rgb(hsb).hex});
 577 }</code></pre>
 578                         <h3 id="getTotalLength">
 579                             getTotalLength
 580                         </h3>
 581                         <p>
 582                             Path specific method. Returns length of the path in pixels.
 583                         </p>
 584                         <h4>Usage</h4>
 585                         <pre class="javascript code"><code>var p = r.path("M100,100c0,50 100-50 100,0c0,50 -100-50 -100,0z");
 586     alert(p.getTotalLength());</code></pre>
 587                         <h3 id="getPointAtLength">
 588                             getPointAtLength
 589                         </h3>
 590                         <div class="sample" id="point-sample"></div>
 591                         <p>
 592                             Path specific method. Returns point description at given length.
 593                         </p>
 594                         <h4>Parameters</h4>
 595                         <ol>
 596                             <li>length <em>number</em> length in pixels from the beginining of the path to the point</li>
 597                         </ol>
 598                         <h4>Usage</h4>
 599                         <pre class="javascript code"><code>var p = r.path("M10,50c0,50,80-50,80,0c0,50-80-50-80,0z");
 600     var point = p.getPointAtLength(30);
 601     r.circle(point.x, point.y, 3);</code></pre>
 602                         <p>Returned object format:</p>
 603                         <ul>
 604                             <li>x – x coordinate of the point</li>
 605                             <li>y – y coordinate of the point</li>
 606                             <li>alpha – angle of the path at the point</li>
 607                         </ul>
 608                         <h3 id="getSubpath">
 609                             getSubpath
 610                         </h3>
 611                         <div class="sample" id="subpath-sample"></div>
 612                         <p>
 613                             Path specific method. Returns the subpath string of a given path.
 614                         </p>
 615                         <h4>Parameters</h4>
 616                         <ol>
 617                             <li>from <em>number</em> length in pixels from the beginining of the path to the beginining of the subpath</li>
 618                             <li>to <em>number</em> length in pixels from the beginining of the path to the end of the subpath</li>
 619                         </ol>
 620                         <h4>Usage</h4>
 621                         <pre class="javascript code"><code>var p = r.path("M10,50c0,50,80-50,80,0c0,50-80-50-80,0z");
 622     var path = p.getSubpath(10, 60);
 623     r.path(path).attr({stroke: "#f00"});</code></pre>
 624                         <h3 id="setSize">
 625                             setSize
 626                         </h3>
 627                         <p>
 628                             If you need to change dimensions of the canvas call this method
 629                         </p>
 630                         <h4>Parameters</h4>
 631                         <ol>
 632                             <li>width <em>number</em> new width of the canvas</li>
 633                             <li>height <em>number</em> new height of the canvas</li>
 634                         </ol>
 635                         <h3 id="setWindow">
 636                             setWindow
 637                         </h3>
 638                         <p>
 639                             Should be called before main Raphael method. Sets which window should be used for drawing. Default is the current one. You need to use it if you want to draw inside <code>iframe</code>
 640                         </p>
 641                         <h4>Parameters</h4>
 642                         <ol>
 643                             <li>window <em>object</em></li>
 644                         </ol>
 645                         <h3 id="getRGB">
 646                             getRGB
 647                         </h3>
 648                         <p>
 649                             Parses passes string and returns an color object. Especially usefull for plug-in developers.
 650                         </p>
 651                         <h4>Parameters</h4>
 652                         <ol>
 653                             <li>color <em>string</em> Color in form acceptable by library</li>
 654                         </ol>
 655                         <h4>Usage</h4>
 656                         <pre class="javascript code"><code>var stroke = Raphael.getRGB(circle.attr("stroke")).hex</code></pre>
 657                         <h3 id="getColor">
 658                             getColor
 659                         </h3>
 660                         <p>
 661                             Returns a colour object for the next colour in spectrum
 662                         </p>
 663                         <h4>Parameters</h4>
 664                         <ol>
 665                             <li>value <em>number</em> brightness [optional]</li>
 666                         </ol>
 667                         <h4>Usage</h4>
 668                         <pre class="javascript code"><code>var c = paper.path("M10,10L100,100").attr({stroke: Raphael.getColor()});</code></pre>
 669                         <h3 id="getColor-reset">
 670                             getColor.reset
 671                         </h3>
 672                         <p>
 673                             Resets getColor function, so it will start from the beginning
 674                         </p>
 675                         <h3 id="registerFont">
 676                             registerFont
 677                         </h3>
 678                         <p>
 679                             Adds given font to the registered set of fonts for Raphaël. Should be used as an internal call from within Cufón’s font file. <a href="http://wiki.github.com/sorccu/cufon/about">More about Cufón and how to convert your font form TTF, OTF, etc to JavaScript file</a>. Returns original parameter, so it could be used with chaining.
 680                         </p>
 681                         <h4>Parameters</h4>
 682                         <ol>
 683                             <li>font <em>object</em> the font to register</li>
 684                         </ol>
 685                         <h4>Usage</h4>
 686                         <pre class="javascript code"><code>Cufon.registerFont(Raphael.registerFont({…}))</code></pre>
 687                         <h3 id="getFont">
 688                             getFont
 689                         </h3>
 690                         <p>
 691                             Finds font object in the registered fonts by given parameters. You could specify only one word from the font name, like “Myriad” for “Myriad Pro”.
 692                         </p>
 693                         <h4>Parameters</h4>
 694                         <ol>
 695                             <li>family <em>string</em> font family name or any word from it</li>
 696                             <li>weight <em>string</em> weight of the font [optional]</li>
 697                             <li>style <em>string</em> style of the font [optional]</li>
 698                             <li>stretch <em>string</em> stretch of the font [optional]</li>
 699                         </ol>
 700                         <h4>Usage</h4>
 701                         <pre class="javascript code"><code>paper.print(100, 100, "Test string", paper.getFont("Times", 800), 30);</code></pre>
 702                         <h3 id="print">
 703                             print
 704                         </h3>
 705                         <div class="sample" id="print-sample"></div>
 706                         <p>
 707                             Creates set of shapes to represent given font at given position with given size. Result of the method is set object (see <a href="#set">set</a>) which contains each letter as separate path object.
 708                         </p>
 709                         <h4>Parameters</h4>
 710                         <ol>
 711                             <li>x <em>number</em> x position of the text</li>
 712                             <li>y <em>number</em> y position of the text</li>
 713                             <li>text <em>string</em> text to print</li>
 714                             <li>font <em>object</em> font object (see <a href="#getFont">getFont</a>)</li>
 715                             <li>font_size <em>number</em> size of the font</li>
 716                         </ol>
 717                         <h4>Usage</h4>
 718                         <pre class="javascript code"><code>var txt = r.print(10, 50, "print", r.getFont("Museo"), 30).attr({fill: "#fff"});
 719 // following line will paint first letter in red
 720 txt[0].attr({fill: "#f00"});</code></pre>
 721                         <h3 id="plugins-canvas">
 722                             Adding your own methods to canvas
 723                         </h3>
 724                         <p>
 725                             You can add your own method to the canvas. For example if you want to draw pie chart, you can create your own pie chart function and ship it as a Raphaël plugin. To do this you need to extend Raphael.fn object. Please note that you can create your own namespaces inside fn object. Methods will be run in context of canvas anyway. You should alter fn object before Raphaël instance was created, otherwise it will take no effect.
 726                         </p>
 727                         <h4>Usage</h4>
 728                         <pre class="javascript code"><code>Raphael.fn.arrow = function (x1, y1, x2, y2, size) {
 729     return this.path( ... );
 730 };
 731 // or create namespace
 732 Raphael.fn.mystuff = {
 733     arrow: function () {…},
 734     star: function () {…},
 735     // etc…
 736 };
 737 var paper = Raphael(10, 10, 630, 480);
 738 // then use it
 739 paper.arrow(10, 10, 30, 30, 5).attr({fill: "#f00"});
 740 paper.mystuff.arrow();
 741 paper.mystuff.star();
 742 </code></pre>
 743                         <h3 id="plugins-elements">
 744                             Adding your own methods to elements
 745                         </h3>
 746                         <p>
 747                             You can add your own method to elements. This is usefull when you want to hack default functionality or want to wrap some common transformation or attributes in one method. In difference to canvas mathods, you can redefine element method at any time.
 748                         </p>
 749                         <h4>Usage</h4>
 750                         <pre class="javascript code"><code>Raphael.el.red = function () {
 751     this.attr({fill: "#f00"});
 752 };
 753 // then use it
 754 paper.circle(100, 100, 20).red();
 755 </code></pre>
 756                         <h3 id="colour">
 757                             Supported colour formats
 758                         </h3>
 759                         <p>
 760                             You could specify colour in this formats:
 761                         </p>
 762                         <ul>
 763                             <li>Colour name (“<samp>red</samp>”, “<samp>green</samp>”, “<samp>cornflowerblue</samp>”, etc)</li>
 764                             <li>#••• — shortened HTML colour: (“<samp>#000</samp>”, “<samp>#fc0</samp>”, etc)</li>
 765                             <li>#•••••• — full length HTML colour: (“<samp>#000000</samp>”, “<samp>#bd2300</samp>”)</li>
 766                             <li>rgb(•••, •••, •••) — red, green and blue channels’ values: (“<samp>rgb(200,&nbsp;100,&nbsp;0)</samp>”)</li>
 767                             <li>rgb(•••%, •••%, •••%) — same as above, but in %: (“<samp>rgb(100%,&nbsp;175%,&nbsp;0%)</samp>”)</li>
 768                             <li>rgba(•••, •••, •••, •••) — red, green and blue channels’ values: (“<samp>rgb(200,&nbsp;100,&nbsp;0, .5)</samp>”)</li>
 769                             <li>rgba(•••%, •••%, •••%, •••%) — same as above, but in %: (“<samp>rgb(100%,&nbsp;175%,&nbsp;0%, 50%)</samp>”)</li>
 770                             <li>hsb(•••, •••, •••) — hue, saturation and brightness values: (“<samp>hsb(0.5,&nbsp;0.25,&nbsp;1)</samp>”)</li>
 771                             <li>hsb(•••%, •••%, •••%) — same as above, but in %</li>
 772                             <li>hsl(•••, •••, •••) — almost the same as hsb, see <a href="http://en.wikipedia.org/wiki/HSL_and_HSV" title="HSL and HSV - Wikipedia, the free encyclopedia">Wikipedia page</a></li>
 773                             <li>hsl(•••%, •••%, •••%) — almost the same as hsb</li>
 774                             <li>Optionally for hsb and hsl you could specify hue as a degree: “<samp>hsl(240deg,&nbsp;1,&nbsp;.5)</samp>” or, if you want to go fancy, “<samp>hsl(240°,&nbsp;1,&nbsp;.5)</samp>”</li>
 775                         </ul>
 776                         <h4>Usage</h4>
 777                         <pre class="javascript code"><code>paper.circle(100, 100, 20).attr({
 778     fill: "hsb(1, 255, 200)",
 779     stroke: "red"
 780 });</code></pre>
 781                         <h3 id="safari">
 782                             safari
 783                         </h3>
 784                         <p>
 785                             There is an inconvenient rendering bug is Safari (WebKit): sometimes the rendering should be forced. This method should help with dealing with this bug.
 786                         </p>
 787                         <h4>Usage</h4>
 788                         <pre class="javascript code"><code>paper.safari();</code></pre>
 789                         <h3 id="ninja-mode">
 790                             “Ninja Mode”
 791                         </h3>
 792                         <p>
 793                             If you want to leave no trace of Raphaël (Well, Raphaël creates only one global variable <code>Raphael</code>, but anyway.) You can use <code>ninja</code> method. Beware, that in this case plugins could stop working, because they are depending on global variable existance.
 794                         </p>
 795                         <h4>Usage</h4>
 796                         <pre class="javascript code"><code>(function (local_raphael) {
 797     var paper = local_raphael(10, 10, 320, 200);
 798     …
 799 })(Raphael.ninja());
 800 </code></pre>
 801                         <h3 id="events">
 802                             Events
 803                         </h3>
 804                         <p>
 805                             You can attach events to elements by using element.node and your favourite library (<samp>$(circle.node).click(…)</samp>) or you can use built-in methods:
 806                         </p>
 807                         <h4>Usage</h4>
 808                         <pre class="javascript code"><code>element.click(function (event) {
 809     this.attr({fill: "red"});
 810 });
 811 element.dblclick(function (event) {
 812     this.attr({fill: "red"});
 813 });
 814 element.mousedown(function (event) {
 815     this.attr({fill: "red"});
 816 });
 817 element.mousemove(function (event) {
 818     this.attr({fill: "red"});
 819 });
 820 element.mouseout(function (event) {
 821     this.attr({fill: "red"});
 822 });
 823 element.mouseover(function (event) {
 824     this.attr({fill: "red"});
 825 });
 826 element.mouseup(function (event) {
 827     this.attr({fill: "red"});
 828 });
 829 element.hover(function (event) {
 830     this.attr({fill: "red"});
 831 }, function (event) {
 832     this.attr({fill: "black"});
 833 });</code></pre>
 834                         <p>
 835                             To unbind events use the same method names with “un” prefix, i.e. <samp>element.unclick(f);</samp>
 836                         </p>
 837                         <h3 id="drag-n-drop">
 838                             Drag ’n’ Drop
 839                         </h3>
 840                         <p>
 841                             To make element “draggable” you need to call method <code>drag</code> on element.
 842                         </p>
 843                         <h4>Parameters</h4>
 844                         <ol>
 845                             <li>onmove <em>function</em> event handler for moving</li>
 846                             <li>onstart <em>function</em> event handler for start</li>
 847                             <li>onend <em>function</em> event handler for end of the drag</li>
 848                         </ol>
 849                         <h4>Usage</h4>
 850                         <pre class="javascript code"><code>var c = R.circle(100, 100, 50).attr({
 851     fill: "hsb(.8, 1, 1)",
 852     stroke: "none",
 853     opacity: .5
 854 });
 855 var start = function () {
 856     // storing original coordinates
 857     this.ox = this.attr("cx");
 858     this.oy = this.attr("cy");
 859     this.attr({opacity: 1});
 860 },
 861 move = function (dx, dy) {
 862     // move will be called with dx and dy
 863     this.attr({cx: this.ox + dx, cy: this.oy + dy});
 864 },
 865 up = function () {
 866     // restoring state
 867     this.attr({opacity: .5});
 868 };
 869 c.drag(move, start, up);</code></pre>
 870                         <p>
 871                             To unbind drag use the <samp>undrag</samp> method.
 872                         </p>
 873                     </div>
 874                     <div id="column-2">
 875                         <h2>
 876                             <a href="index.html">Home</a>
 877                         </h2>
 878                         <h2>
 879                             Contents
 880                         </h2>
 881                         <ul id="contents">
 882                             <li>
 883                                 <a href="#Raphael"><code>Raphael</code></a>
 884                             </li>
 885                             <li>
 886                                 <a href="#circle"><code>circle</code></a>
 887                             </li>
 888                             <li>
 889                                 <a href="#rect"><code>rect</code></a>
 890                             </li>
 891                             <li>
 892                                 <a href="#ellipse"><code>ellipse</code></a>
 893                             </li>
 894                             <li>
 895                                 <a href="#image"><code>image</code></a>
 896                             </li>
 897                             <li>
 898                                 <a href="#set"><code>set</code></a>
 899                             </li>
 900                             <li>
 901                                 <a href="#text"><code>text</code></a>
 902                             </li>
 903                             <li>
 904                                 <a href="#path"><code>path</code></a>
 905                             </li>
 906                             <li>
 907                                 <a href="#clear"><code>clear</code></a>
 908                             </li>
 909                             <li>
 910                                 <a href="#node"><code>node</code></a>
 911                             </li>
 912                             <li>
 913                                 <a href="#paper"><code>paper</code></a>
 914                             </li>
 915                             <li>
 916                                 <a href="#remove"><code>remove</code></a>
 917                             </li>
 918                             <li>
 919                                 <a href="#hide"><code>hide</code></a>
 920                             </li>
 921                             <li>
 922                                 <a href="#show"><code>show</code></a>
 923                             </li>
 924                             <li>
 925                                 <a href="#rotate"><code>rotate</code></a>
 926                             </li>
 927                             <li>
 928                                 <a href="#translate"><code>translate</code></a>
 929                             </li>
 930                             <li>
 931                                 <a href="#scale"><code>scale</code></a>
 932                             </li>
 933                             <li>
 934                                 <a href="#attr"><code>attr</code></a>
 935                             </li>
 936                             <li>
 937                                 <a href="#animate"><code>animate</code></a>
 938                             </li>
 939                             <li>
 940                                 <a href="#animateWith"><code>animateWith</code></a>
 941                             </li>
 942                             <li>
 943                                 <a href="#animateAlong"><code>animateAlong</code></a>
 944                             </li>
 945                             <li>
 946                                 <a href="#animateAlongBack"><code>animateAlongBack</code></a>
 947                             </li>
 948                             <li>
 949                                 <a href="#getBBox"><code>getBBox</code></a>
 950                             </li>
 951                             <li>
 952                                 <a href="#toFront"><code>toFront</code></a>
 953                             </li>
 954                             <li>
 955                                 <a href="#toBack"><code>toBack</code></a>
 956                             </li>
 957                             <li>
 958                                 <a href="#insertBefore"><code>insertBefore</code></a>
 959                             </li>
 960                             <li>
 961                                 <a href="#insertAfter"><code>insertAfter</code></a>
 962                             </li>
 963                             <li>
 964                                 <a href="#clone"><code>clone</code></a>
 965                             </li>
 966                             <li>
 967                                 <a href="#raphael"><code>raphael</code></a>
 968                             </li>
 969                             <li>
 970                                 <a href="#getTotalLength"><code>getTotalLength</code></a>
 971                             </li>
 972                             <li>
 973                                 <a href="#getPointAtLength"><code>getPointAtLength</code></a>
 974                             </li>
 975                             <li>
 976                                 <a href="#getSubpath"><code>getSubpath</code></a>
 977                             </li>
 978                             <li>
 979                                 <a href="#setSize"><code>setSize</code></a>
 980                             </li>
 981                             <li>
 982                                 <a href="#setWindow"><code>setWindow</code></a>
 983                             </li>
 984                             <li>
 985                                 <a href="#getRGB"><code>getRGB</code></a>
 986                             </li>
 987                             <li>
 988                                 <a href="#getColor"><code>getColor</code></a>
 989                             </li>
 990                             <li>
 991                                 <a href="#getColor-reset"><code>getColor.reset</code></a>
 992                             </li>
 993                             <li>
 994                                 <a href="#registerFont"><code>registerFont</code></a>
 995                             </li>
 996                             <li>
 997                                 <a href="#getFont"><code>getFont</code></a>
 998                             </li>
 999                             <li>
1000                                 <a href="#print"><code>print</code></a>
1001                             </li>
1002                             <li>
1003                                 <a href="#plugins-canvas">Adding your own methods to canvas</a>
1004                             </li>
1005                             <li>
1006                                 <a href="#plugins-elements">Adding your own methods to elements</a>
1007                             </li>
1008                             <li>
1009                                 <a href="#colour">Supported colour formats</a>
1010                             </li>
1011                             <li>
1012                                 <a href="#safari">safari</a>
1013                             </li>
1014                             <li>
1015                                 <a href="#ninja-mode">“Ninja Mode”</a>
1016                             </li>
1017                             <li>
1018                                 <a href="#events">Events</a>
1019                             </li>
1020                         </ul>
1021                     </div>
1022                     <div  id="footer">
1023                         <h3 id="copyright">
1024                             <a href="http://www.opensource.org/licenses/mit-license.php" title="MIT License" rel="license">Some Rights Reserved</a> by <a href="http://dmitry.baranovskiy.com/">Dmitry Baranovskiy</a>
1025                         </h3>
1026                         <h3 id="font">
1027                             Logo by <a href="http://wasabicube.com/">Wasabicube</a>
1028                         </h3>
1029                     </div>
1030         </div>
1031         <script src="raphael.js" type="text/javascript" charset="utf-8"></script>
1032         <script src="syntax.js" type="text/javascript" charset="utf-8"></script>
1033         <script src="museo.js" type="text/javascript" charset="utf-8"></script>
1034         <script src="site.js" type="text/javascript" charset="utf-8"></script>
1035         <script type="text/javascript">
1036         var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
1037         document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
1038         </script>
1039         <script type="text/javascript">
1040         var pageTracker = _gat._getTracker("UA-616618-3");
1041         pageTracker._trackPageview();
1042         </script>
1043     </body>
1044 </html>