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

   1 <!DOCTYPE html>
   2 <!-- Generated with Dr.js -->
   3 <html lang="en"><head><meta charset="utf-8"><title>Raphaël Reference</title><link rel="stylesheet" href="dr.css" media="screen"><link rel="stylesheet" href="dr-print.css" media="print"></head><body id="dr-js"><div id="dr"><ol class="dr-toc" id="dr-toc"><li class="dr-lvl0"><a href="#Animation" class="{clas}"><span>Animation</span></a></li><li class="dr-lvl1"><a href="#Animation.delay" class="dr-method"><span>Animation.delay()</span></a></li><li class="dr-lvl1"><a href="#Animation.repeat" class="dr-method"><span>Animation.repeat()</span></a></li><li class="dr-lvl0"><a href="#Element" class="{clas}"><span>Element</span></a></li><li class="dr-lvl1"><a href="#Element.animate" class="dr-method"><span>Element.animate()</span></a></li><li class="dr-lvl1"><a href="#Element.animateWith" class="dr-method"><span>Element.animateWith()</span></a></li><li class="dr-lvl1"><a href="#Element.attr" class="dr-method"><span>Element.attr()</span></a></li><li class="dr-lvl1"><a href="#Element.click" class="dr-method"><span>Element.click()</span></a></li><li class="dr-lvl1"><a href="#Element.clone" class="dr-method"><span>Element.clone()</span></a></li><li class="dr-lvl1"><a href="#Element.data" class="dr-method"><span>Element.data()</span></a></li><li class="dr-lvl1"><a href="#Element.dblclick" class="dr-method"><span>Element.dblclick()</span></a></li><li class="dr-lvl1"><a href="#Element.drag" class="dr-method"><span>Element.drag()</span></a></li><li class="dr-lvl1"><a href="#Element.getBBox" class="dr-method"><span>Element.getBBox()</span></a></li><li class="dr-lvl1"><a href="#Element.getPointAtLength" class="dr-method"><span>Element.getPointAtLength()</span></a></li><li class="dr-lvl1"><a href="#Element.getSubpath" class="dr-method"><span>Element.getSubpath()</span></a></li><li class="dr-lvl1"><a href="#Element.getTotalLength" class="dr-method"><span>Element.getTotalLength()</span></a></li><li class="dr-lvl1"><a href="#Element.glow" class="dr-method"><span>Element.glow()</span></a></li><li class="dr-lvl1"><a href="#Element.hide" class="dr-method"><span>Element.hide()</span></a></li><li class="dr-lvl1"><a href="#Element.hover" class="dr-method"><span>Element.hover()</span></a></li><li class="dr-lvl1"><a href="#Element.id" class="dr-property"><span>Element.id</span></a></li><li class="dr-lvl1"><a href="#Element.insertAfter" class="dr-method"><span>Element.insertAfter()</span></a></li><li class="dr-lvl1"><a href="#Element.insertBefore" class="dr-method"><span>Element.insertBefore()</span></a></li><li class="dr-lvl1"><a href="#Element.mousedown" class="dr-method"><span>Element.mousedown()</span></a></li><li class="dr-lvl1"><a href="#Element.mousemove" class="dr-method"><span>Element.mousemove()</span></a></li><li class="dr-lvl1"><a href="#Element.mouseout" class="dr-method"><span>Element.mouseout()</span></a></li><li class="dr-lvl1"><a href="#Element.mouseover" class="dr-method"><span>Element.mouseover()</span></a></li><li class="dr-lvl1"><a href="#Element.mouseup" class="dr-method"><span>Element.mouseup()</span></a></li><li class="dr-lvl1"><a href="#Element.next" class="dr-property"><span>Element.next</span></a></li><li class="dr-lvl1"><a href="#Element.node" class="dr-property"><span>Element.node</span></a></li><li class="dr-lvl1"><a href="#Element.onDragOver" class="dr-method"><span>Element.onDragOver()</span></a></li><li class="dr-lvl1"><a href="#Element.paper" class="dr-property"><span>Element.paper</span></a></li><li class="dr-lvl1"><a href="#Element.pause" class="dr-method"><span>Element.pause()</span></a></li><li class="dr-lvl1"><a href="#Element.prev" class="dr-property"><span>Element.prev</span></a></li><li class="dr-lvl1"><a href="#Element.raphael" class="dr-property"><span>Element.raphael</span></a></li><li class="dr-lvl1"><a href="#Element.remove" class="dr-method"><span>Element.remove()</span></a></li><li class="dr-lvl1"><a href="#Element.removeData" class="dr-method"><span>Element.removeData()</span></a></li><li class="dr-lvl1"><a href="#Element.resume" class="dr-method"><span>Element.resume()</span></a></li><li class="dr-lvl1"><a href="#Element.rotate" class="dr-method"><span>Element.rotate()</span></a></li><li class="dr-lvl1"><a href="#Element.scale" class="dr-method"><span>Element.scale()</span></a></li><li class="dr-lvl1"><a href="#Element.setTime" class="dr-method"><span>Element.setTime()</span></a></li><li class="dr-lvl1"><a href="#Element.show" class="dr-method"><span>Element.show()</span></a></li><li class="dr-lvl1"><a href="#Element.status" class="dr-method"><span>Element.status()</span></a></li><li class="dr-lvl1"><a href="#Element.stop" class="dr-method"><span>Element.stop()</span></a></li><li class="dr-lvl1"><a href="#Element.toBack" class="dr-method"><span>Element.toBack()</span></a></li><li class="dr-lvl1"><a href="#Element.toFront" class="dr-method"><span>Element.toFront()</span></a></li><li class="dr-lvl1"><a href="#Element.touchcancel" class="dr-method"><span>Element.touchcancel()</span></a></li><li class="dr-lvl1"><a href="#Element.touchend" class="dr-method"><span>Element.touchend()</span></a></li><li class="dr-lvl1"><a href="#Element.touchmove" class="dr-method"><span>Element.touchmove()</span></a></li><li class="dr-lvl1"><a href="#Element.touchstart" class="dr-method"><span>Element.touchstart()</span></a></li><li class="dr-lvl1"><a href="#Element.transform" class="dr-method"><span>Element.transform()</span></a></li><li class="dr-lvl1"><a href="#Element.translate" class="dr-method"><span>Element.translate()</span></a></li><li class="dr-lvl1"><a href="#Element.unclick" class="dr-method"><span>Element.unclick()</span></a></li><li class="dr-lvl1"><a href="#Element.undblclick" class="dr-method"><span>Element.undblclick()</span></a></li><li class="dr-lvl1"><a href="#Element.undrag" class="dr-method"><span>Element.undrag()</span></a></li><li class="dr-lvl1"><a href="#Element.unhover" class="dr-method"><span>Element.unhover()</span></a></li><li class="dr-lvl1"><a href="#Element.unmousedown" class="dr-method"><span>Element.unmousedown()</span></a></li><li class="dr-lvl1"><a href="#Element.unmousemove" class="dr-method"><span>Element.unmousemove()</span></a></li><li class="dr-lvl1"><a href="#Element.unmouseout" class="dr-method"><span>Element.unmouseout()</span></a></li><li class="dr-lvl1"><a href="#Element.unmouseover" class="dr-method"><span>Element.unmouseover()</span></a></li><li class="dr-lvl1"><a href="#Element.unmouseup" class="dr-method"><span>Element.unmouseup()</span></a></li><li class="dr-lvl1"><a href="#Element.untouchcancel" class="dr-method"><span>Element.untouchcancel()</span></a></li><li class="dr-lvl1"><a href="#Element.untouchend" class="dr-method"><span>Element.untouchend()</span></a></li><li class="dr-lvl1"><a href="#Element.untouchmove" class="dr-method"><span>Element.untouchmove()</span></a></li><li class="dr-lvl1"><a href="#Element.untouchstart" class="dr-method"><span>Element.untouchstart()</span></a></li><li class="dr-lvl0"><a href="#Matrix" class="{clas}"><span>Matrix</span></a></li><li class="dr-lvl1"><a href="#Matrix.add" class="dr-method"><span>Matrix.add()</span></a></li><li class="dr-lvl1"><a href="#Matrix.clone" class="dr-method"><span>Matrix.clone()</span></a></li><li class="dr-lvl1"><a href="#Matrix.invert" class="dr-method"><span>Matrix.invert()</span></a></li><li class="dr-lvl1"><a href="#Matrix.rotate" class="dr-method"><span>Matrix.rotate()</span></a></li><li class="dr-lvl1"><a href="#Matrix.scale" class="dr-method"><span>Matrix.scale()</span></a></li><li class="dr-lvl1"><a href="#Matrix.split" class="dr-method"><span>Matrix.split()</span></a></li><li class="dr-lvl1"><a href="#Matrix.toTransformString" class="dr-method"><span>Matrix.toTransformString()</span></a></li><li class="dr-lvl1"><a href="#Matrix.translate" class="dr-method"><span>Matrix.translate()</span></a></li><li class="dr-lvl1"><a href="#Matrix.x" class="dr-method"><span>Matrix.x()</span></a></li><li class="dr-lvl1"><a href="#Matrix.y" class="dr-method"><span>Matrix.y()</span></a></li><li class="dr-lvl0"><a href="#Paper" class="{clas}"><span>Paper</span></a></li><li class="dr-lvl1"><a href="#Paper.bottom" class="dr-property"><span>Paper.bottom</span></a></li><li class="dr-lvl1"><a href="#Paper.ca" class="dr-property"><span>Paper.ca</span></a></li><li class="dr-lvl1"><a href="#Paper.circle" class="dr-method"><span>Paper.circle()</span></a></li><li class="dr-lvl1"><a href="#Paper.clear" class="dr-method"><span>Paper.clear()</span></a></li><li class="dr-lvl1"><a href="#Paper.customAttributes" class="dr-property"><span>Paper.customAttributes</span></a></li><li class="dr-lvl1"><a href="#Paper.ellipse" class="dr-method"><span>Paper.ellipse()</span></a></li><li class="dr-lvl1"><a href="#Paper.forEach" class="dr-method"><span>Paper.forEach()</span></a></li><li class="dr-lvl1"><a href="#Paper.getById" class="dr-method"><span>Paper.getById()</span></a></li><li class="dr-lvl1"><a href="#Paper.getElementByPoint" class="dr-method"><span>Paper.getElementByPoint()</span></a></li><li class="dr-lvl1"><a href="#Paper.getFont" class="dr-method"><span>Paper.getFont()</span></a></li><li class="dr-lvl1"><a href="#Paper.image" class="dr-method"><span>Paper.image()</span></a></li><li class="dr-lvl1"><a href="#Paper.path" class="dr-method"><span>Paper.path()</span></a></li><li class="dr-lvl1"><a href="#Paper.print" class="dr-method"><span>Paper.print()</span></a></li><li class="dr-lvl1"><a href="#Paper.raphael" class="dr-property"><span>Paper.raphael</span></a></li><li class="dr-lvl1"><a href="#Paper.rect" class="dr-method"><span>Paper.rect()</span></a></li><li class="dr-lvl1"><a href="#Paper.remove" class="dr-method"><span>Paper.remove()</span></a></li><li class="dr-lvl1"><a href="#Paper.renderfix" class="dr-method"><span>Paper.renderfix()</span></a></li><li class="dr-lvl1"><a href="#Paper.safari" class="dr-method"><span>Paper.safari()</span></a></li><li class="dr-lvl1"><a href="#Paper.set" class="dr-method"><span>Paper.set()</span></a></li><li class="dr-lvl1"><a href="#Paper.setFinish" class="dr-method"><span>Paper.setFinish()</span></a></li><li class="dr-lvl1"><a href="#Paper.setSize" class="dr-method"><span>Paper.setSize()</span></a></li><li class="dr-lvl1"><a href="#Paper.setStart" class="dr-method"><span>Paper.setStart()</span></a></li><li class="dr-lvl1"><a href="#Paper.setViewBox" class="dr-method"><span>Paper.setViewBox()</span></a></li><li class="dr-lvl1"><a href="#Paper.text" class="dr-method"><span>Paper.text()</span></a></li><li class="dr-lvl1"><a href="#Paper.top" class="dr-property"><span>Paper.top</span></a></li><li class="dr-lvl0"><a href="#Raphael" class="dr-method"><span>Raphael()</span></a></li><li class="dr-lvl1"><a href="#Raphael.angle" class="dr-method"><span>Raphael.angle()</span></a></li><li class="dr-lvl1"><a href="#Raphael.animation" class="dr-method"><span>Raphael.animation()</span></a></li><li class="dr-lvl1"><a href="#Raphael.color" class="dr-method"><span>Raphael.color()</span></a></li><li class="dr-lvl1"><a href="#Raphael.createUUID" class="dr-method"><span>Raphael.createUUID()</span></a></li><li class="dr-lvl1"><a href="#Raphael.deg" class="dr-method"><span>Raphael.deg()</span></a></li><li class="dr-lvl1"><a href="#Raphael.easing_formulas" class="dr-property"><span>Raphael.easing_formulas</span></a></li><li class="dr-lvl1"><a href="#Raphael.el" class="dr-property"><span>Raphael.el</span></a></li><li class="dr-lvl1"><a href="#Raphael.findDotsAtSegment" class="dr-method"><span>Raphael.findDotsAtSegment()</span></a></li><li class="dr-lvl1"><a href="#Raphael.fn" class="dr-property"><span>Raphael.fn</span></a></li><li class="dr-lvl1"><a href="#Raphael.format" class="dr-method"><span>Raphael.format()</span></a></li><li class="dr-lvl1"><a href="#Raphael.fullfill" class="dr-method"><span>Raphael.fullfill()</span></a></li><li class="dr-lvl1"><a href="#Raphael.getColor" class="dr-method"><span>Raphael.getColor()</span></a></li><li class="dr-lvl2"><a href="#Raphael.getColor.reset" class="dr-method"><span>Raphael.getColor.reset()</span></a></li><li class="dr-lvl1"><a href="#Raphael.getPointAtLength" class="dr-method"><span>Raphael.getPointAtLength()</span></a></li><li class="dr-lvl1"><a href="#Raphael.getRGB" class="dr-method"><span>Raphael.getRGB()</span></a></li><li class="dr-lvl1"><a href="#Raphael.getSubpath" class="dr-method"><span>Raphael.getSubpath()</span></a></li><li class="dr-lvl1"><a href="#Raphael.getTotalLength" class="dr-method"><span>Raphael.getTotalLength()</span></a></li><li class="dr-lvl1"><a href="#Raphael.hsb" class="dr-method"><span>Raphael.hsb()</span></a></li><li class="dr-lvl1"><a href="#Raphael.hsb2rgb" class="dr-method"><span>Raphael.hsb2rgb()</span></a></li><li class="dr-lvl1"><a href="#Raphael.hsl" class="dr-method"><span>Raphael.hsl()</span></a></li><li class="dr-lvl1"><a href="#Raphael.hsl2rgb" class="dr-method"><span>Raphael.hsl2rgb()</span></a></li><li class="dr-lvl1"><a href="#Raphael.is" class="dr-method"><span>Raphael.is()</span></a></li><li class="dr-lvl1"><a href="#Raphael.matrix" class="dr-method"><span>Raphael.matrix()</span></a></li><li class="dr-lvl1"><a href="#Raphael.ninja" class="dr-method"><span>Raphael.ninja()</span></a></li><li class="dr-lvl1"><a href="#Raphael.parsePathString" class="dr-method"><span>Raphael.parsePathString()</span></a></li><li class="dr-lvl1"><a href="#Raphael.parseTransformString" class="dr-method"><span>Raphael.parseTransformString()</span></a></li><li class="dr-lvl1"><a href="#Raphael.path2curve" class="dr-method"><span>Raphael.path2curve()</span></a></li><li class="dr-lvl1"><a href="#Raphael.pathToRelative" class="dr-method"><span>Raphael.pathToRelative()</span></a></li><li class="dr-lvl1"><a href="#Raphael.rad" class="dr-method"><span>Raphael.rad()</span></a></li><li class="dr-lvl1"><a href="#Raphael.registerFont" class="dr-method"><span>Raphael.registerFont()</span></a></li><li class="dr-lvl1"><a href="#Raphael.rgb" class="dr-method"><span>Raphael.rgb()</span></a></li><li class="dr-lvl1"><a href="#Raphael.rgb2hsb" class="dr-method"><span>Raphael.rgb2hsb()</span></a></li><li class="dr-lvl1"><a href="#Raphael.rgb2hsl" class="dr-method"><span>Raphael.rgb2hsl()</span></a></li><li class="dr-lvl1"><a href="#Raphael.setWindow" class="dr-method"><span>Raphael.setWindow()</span></a></li><li class="dr-lvl1"><a href="#Raphael.snapTo" class="dr-method"><span>Raphael.snapTo()</span></a></li><li class="dr-lvl1"><a href="#Raphael.st" class="dr-property"><span>Raphael.st</span></a></li><li class="dr-lvl1"><a href="#Raphael.svg" class="dr-property"><span>Raphael.svg</span></a></li><li class="dr-lvl1"><a href="#Raphael.type" class="dr-property"><span>Raphael.type</span></a></li><li class="dr-lvl1"><a href="#Raphael.vml" class="dr-property"><span>Raphael.vml</span></a></li><li class="dr-lvl0"><a href="#Set" class="{clas}"><span>Set</span></a></li><li class="dr-lvl1"><a href="#Set.clear" class="dr-method"><span>Set.clear()</span></a></li><li class="dr-lvl1"><a href="#Set.exclude" class="dr-method"><span>Set.exclude()</span></a></li><li class="dr-lvl1"><a href="#Set.forEach" class="dr-method"><span>Set.forEach()</span></a></li><li class="dr-lvl1"><a href="#Set.pop" class="dr-method"><span>Set.pop()</span></a></li><li class="dr-lvl1"><a href="#Set.push" class="dr-method"><span>Set.push()</span></a></li><li class="dr-lvl1"><a href="#Set.splice" class="dr-method"><span>Set.splice()</span></a></li><li class="dr-lvl0"><a href="#eve" class="dr-method"><span>eve()</span></a></li><li class="dr-lvl1"><a href="#eve.listeners" class="dr-method"><span>eve.listeners()</span></a></li><li class="dr-lvl1"><a href="#eve.nt" class="dr-method"><span>eve.nt()</span></a></li><li class="dr-lvl1"><a href="#eve.on" class="dr-method"><span>eve.on()</span></a></li><li class="dr-lvl1"><a href="#eve.stop" class="dr-method"><span>eve.stop()</span></a></li><li class="dr-lvl1"><a href="#eve.unbind" class="dr-method"><span>eve.unbind()</span></a></li><li class="dr-lvl1"><a href="#eve.version" class="dr-property"><span>eve.version</span></a></li></ol><div class="dr-doc"><h1>Raphaël Reference</h1><div class="Animation-section"><h2 id="Animation" class="undefined"><i class="dr-trixie">&#160;</i>Animation<a href="#Animation" title="Link to this section" class="dr-hash">&#x2693;</a></h2>
   4 <div class="extra" id="Animation-extra"></div></div><div class="Animation-delay-section"><h3 id="Animation.delay" class="dr-method"><i class="dr-trixie">&#160;</i>Animation.delay(delay)<a href="#Animation.delay" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3709 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3709">&#x27ad;</a></h3>
   5 <div class="extra" id="Animation.delay-extra"></div></div><div class="dr-method"><p>Creates a copy of existing animation object with given delay.
   6 </p>
   7 <p class="header">Parameters
   8 </p>
   9 <dl class="dr-parameters"><dt class="dr-param">delay</dt>
  10 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  11 <dd class="dr-description">number of ms to pass between animation start and actual animation</dd>
  12 </dl>
  13 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">new altered Animation object</span></p>
  14 <pre class="javascript code"><code><b>var</b> anim<span class="s"> = </span>Raphael.animation({cx: <span class="d">10</span>, cy: <span class="d">20</span>}, <span class="d">2e3</span>);
  15 circle1.animate(anim); <span class="c">// run the given animation immediately</span>
  16 circle2.animate(anim.delay(<span class="d">500</span>)); <span class="c">// run the given animation after <span class="d">500</span> ms</span>
  17 </code></pre>
  18 </div><div class="Animation-repeat-section"><h3 id="Animation.repeat" class="dr-method"><i class="dr-trixie">&#160;</i>Animation.repeat(repeat)<a href="#Animation.repeat" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3727 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3727">&#x27ad;</a></h3>
  19 <div class="extra" id="Animation.repeat-extra"></div></div><div class="dr-method"><p>Creates a copy of existing animation object with given repetition.
  20 </p>
  21 <p class="header">Parameters
  22 </p>
  23 <dl class="dr-parameters"><dt class="dr-param">repeat</dt>
  24 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  25 <dd class="dr-description">number iterations of animation. For infinite animation pass <code>Infinity</code></dd>
  26 </dl>
  27 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">new altered Animation object</span></p>
  28 </div><div class="Element-section"><h2 id="Element" class="undefined"><i class="dr-trixie">&#160;</i>Element<a href="#Element" title="Link to this section" class="dr-hash">&#x2693;</a></h2>
  29 <div class="extra" id="Element-extra"></div></div><div class="Element-animate-section"><h3 id="Element.animate" class="dr-method"><i class="dr-trixie">&#160;</i>Element.animate(…)<a href="#Element.animate" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3997 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3997">&#x27ad;</a></h3>
  30 <div class="extra" id="Element.animate-extra"></div></div><div class="dr-method"><p>Creates and starts animation for given element.
  31 </p>
  32 <p class="header">Parameters
  33 </p>
  34 <dl class="dr-parameters"><dt class="dr-param">params</dt>
  35 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  36 <dd class="dr-description">final attributes for the element, see also <a href="#Element.attr" class="dr-link">Element.attr</a></dd>
  37 <dt class="dr-param">ms</dt>
  38 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  39 <dd class="dr-description">number of milliseconds for animation to run</dd>
  40 <dt class="dr-param optional">easing</dt>
  41 <dd class="dr-optional">optional</dd>
  42 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
  43 <dd class="dr-description">easing type. Accept one of <a href="#Raphael.easing_formulas" class="dr-link">Raphael.easing_formulas</a> or CSS format: <code>cubic&#x2010;bezier(XX,&#160;XX,&#160;XX,&#160;XX)</code></dd>
  44 <dt class="dr-param optional">callback</dt>
  45 <dd class="dr-optional">optional</dd>
  46 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
  47 <dd class="dr-description">callback function. Will be called at the end of animation.</dd>
  48 </dl>
  49 <p>or
  50 </p>
  51 <dl class="dr-parameters"><dt class="dr-param">animation</dt>
  52 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  53 <dd class="dr-description">animation object, see <a href="#Raphael.animation" class="dr-link">Raphael.animation</a></dd>
  54 </dl>
  55 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element</span></p>
  56 </div><div class="Element-animateWith-section"><h3 id="Element.animateWith" class="dr-method"><i class="dr-trixie">&#160;</i>Element.animateWith(…)<a href="#Element.animateWith" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3617 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3617">&#x27ad;</a></h3>
  57 <div class="extra" id="Element.animateWith-extra"></div></div><div class="dr-method"><p>Acts similar to <a href="#Element.animate" class="dr-link">Element.animate</a>, but ensure that given animation runs in sync with another given element.
  58 </p>
  59 <p class="header">Parameters
  60 </p>
  61 <dl class="dr-parameters"><dt class="dr-param">element</dt>
  62 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  63 <dd class="dr-description">element to sync with</dd>
  64 <dt class="dr-param">anim</dt>
  65 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  66 <dd class="dr-description">animation to sync with</dd>
  67 <dt class="dr-param optional">params</dt>
  68 <dd class="dr-optional">optional</dd>
  69 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  70 <dd class="dr-description">final attributes for the element, see also <a href="#Element.attr" class="dr-link">Element.attr</a></dd>
  71 <dt class="dr-param optional">ms</dt>
  72 <dd class="dr-optional">optional</dd>
  73 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  74 <dd class="dr-description">number of milliseconds for animation to run</dd>
  75 <dt class="dr-param optional">easing</dt>
  76 <dd class="dr-optional">optional</dd>
  77 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
  78 <dd class="dr-description">easing type. Accept on of <a href="#Raphael.easing_formulas" class="dr-link">Raphael.easing_formulas</a> or CSS format: <code>cubic&#x2010;bezier(XX,&#160;XX,&#160;XX,&#160;XX)</code></dd>
  79 <dt class="dr-param optional">callback</dt>
  80 <dd class="dr-optional">optional</dd>
  81 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
  82 <dd class="dr-description">callback function. Will be called at the end of animation.</dd>
  83 </dl>
  84 <p>or
  85 </p>
  86 <dl class="dr-parameters"><dt class="dr-param">element</dt>
  87 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  88 <dd class="dr-description">element to sync with</dd>
  89 <dt class="dr-param">anim</dt>
  90 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  91 <dd class="dr-description">animation to sync with</dd>
  92 <dt class="dr-param optional">animation</dt>
  93 <dd class="dr-optional">optional</dd>
  94 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  95 <dd class="dr-description">animation object, see <a href="#Raphael.animation" class="dr-link">Raphael.animation</a></dd>
  96 </dl>
  97 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element</span></p>
  98 </div><div class="Element-attr-section"><h3 id="Element.attr" class="dr-method"><i class="dr-trixie">&#160;</i>Element.attr(…)<a href="#Element.attr" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 982 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L982">&#x27ad;</a></h3>
  99 <div class="extra" id="Element.attr-extra"></div></div><div class="dr-method"><p>Sets the attributes of the element.
 100 </p>
 101 <p class="header">Parameters
 102 </p>
 103 <dl class="dr-parameters"><dt class="dr-param">attrName</dt>
 104 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 105 <dd class="dr-description">attribute’s name</dd>
 106 <dt class="dr-param">value</dt>
 107 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 108 <dd class="dr-description">value</dd>
 109 </dl>
 110 <p>or
 111 </p>
 112 <dl class="dr-parameters"><dt class="dr-param">params</dt>
 113 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 114 <dd class="dr-description">object of name/value pairs</dd>
 115 </dl>
 116 <p>or
 117 </p>
 118 <dl class="dr-parameters"><dt class="dr-param">attrName</dt>
 119 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 120 <dd class="dr-description">attribute’s name</dd>
 121 </dl>
 122 <p>or
 123 </p>
 124 <dl class="dr-parameters"><dt class="dr-param">attrNames</dt>
 125 <dd class="dr-type"><em class="dr-type-array">array</em></dd>
 126 <dd class="dr-description">in this case method returns array of current values for given attribute names</dd>
 127 </dl>
 128 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a> if attrsName <em class="amp">&amp;</em> value or params are passed in.</span></p>
 129 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-...">...</em> <span class="dr-description">value of the attribute if only attrsName is passed in.</span></p>
 130 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">array of values of the attribute if attrsNames is passed in.</span></p>
 131 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">object of attributes if nothing is passed in.</span></p>
 132 <p class="header">Possible parameters
 133 </p>
 134 <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>
 135 <ol class="dr-json"><li><span class="dr-json-key">arrow-end</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">arrowhead on the end of the path. The format for string is <code>&lt;type>[-&lt;width>[-&lt;length>]]</code>. Possible types: <code>classic</code>, <code>block</code>, <code>open</code>, <code>oval</code>, <code>diamond</code>, <code>none</code>, width: <code>wide</code>, <code>narrow</code>, <code>midium</code>, length: <code>long</code>, <code>short</code>, <code>midium</code>.</span>
 136 <li><span class="dr-json-key">clip-rect</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">comma or space separated values: x, y, width and height</span>
 137 <li><span class="dr-json-key">cursor</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">CSS type of the cursor</span>
 138 <li><span class="dr-json-key">cx</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 139 <li><span class="dr-json-key">cy</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 140 <li><span class="dr-json-key">fill</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">colour, gradient or image</span>
 141 <li><span class="dr-json-key">fill-opacity</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 142 <li><span class="dr-json-key">font</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">&#160;</span>
 143 <li><span class="dr-json-key">font-family</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">&#160;</span>
 144 <li><span class="dr-json-key">font-size</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">font size in pixels</span>
 145 <li><span class="dr-json-key">font-weight</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">&#160;</span>
 146 <li><span class="dr-json-key">height</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 147 <li><span class="dr-json-key">href</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">URL, if specified element behaves as hyperlink</span>
 148 <li><span class="dr-json-key">opacity</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 149 <li><span class="dr-json-key">path</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">SVG path string format</span>
 150 <li><span class="dr-json-key">r</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 151 <li><span class="dr-json-key">rx</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 152 <li><span class="dr-json-key">ry</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 153 <li><span class="dr-json-key">src</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">image URL, only works for <a href="#Element.image" class="dr-link">Element.image</a> element</span>
 154 <li><span class="dr-json-key">stroke</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">stroke colour</span>
 155 <li><span class="dr-json-key">stroke-dasharray</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">[“”, “<code>-</code>”, “<code>.</code>”, “<code>-.</code>”, “<code>-..</code>”, “<code>. </code>”, “<code>- </code>”, “<code>--</code>”, “<code>- .</code>”, “<code>--.</code>”, “<code>--..</code>”]</span>
 156 <li><span class="dr-json-key">stroke-linecap</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">[“<code>butt</code>”, “<code>square</code>”, “<code>round</code>”]</span>
 157 <li><span class="dr-json-key">stroke-linejoin</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">[“<code>bevel</code>”, “<code>round</code>”, “<code>miter</code>”]</span>
 158 <li><span class="dr-json-key">stroke-miterlimit</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 159 <li><span class="dr-json-key">stroke-opacity</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 160 <li><span class="dr-json-key">stroke-width</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">stroke width in pixels, default is '1'</span>
 161 <li><span class="dr-json-key">target</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">used with href</span>
 162 <li><span class="dr-json-key">text</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">contents of the text element. Use <code>\n</code> for multiline text</span>
 163 <li><span class="dr-json-key">text-anchor</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">[“<code>start</code>”, “<code>middle</code>”, “<code>end</code>”], default is “<code>middle</code>”</span>
 164 <li><span class="dr-json-key">title</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">will create tooltip with a given text</span>
 165 <li><span class="dr-json-key">transform</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">see <a href="#Element.transform" class="dr-link">Element.transform</a></span>
 166 <li><span class="dr-json-key">width</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 167 <li><span class="dr-json-key">x</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 168 <li><span class="dr-json-key">y</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">&#160;</span>
 169 </ol>
 170 <p class="header">Gradients
 171 <p>Linear gradient format: “<code>‹angle›-‹colour›[-‹colour›[:‹offset›]]*-‹colour›</code>”, example: “<code>90-#fff-#000</code>” – 90°
 172 gradient from white to black or “<code>0-#fff-#f00:20-#000</code>” – 0° gradient from white via red (at 20%) to black.
 173 </p>
 174 <p>radial gradient: “<code>r[(‹fx›, ‹fy›)]‹colour›[-‹colour›[:‹offset›]]*-‹colour›</code>”, example: “<code>r#fff-#000</code>” –
 175 gradient from white to black or “<code>r(0.25, 0.75)#fff-#000</code>” – gradient from white to black with focus point
 176 at 0.25, 0.75. Focus point coordinates are in 0..1 range. Radial gradients can only be applied to circles and ellipses.
 177 </p>
 178 <p class="header">Path String
 179 </p>
 180 <p>Please refer to <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 documentation regarding path string</a>. Raphaël fully supports it.</p>
 181 <p class="header">Colour Parsing
 182 </p>
 183 <ul>
 184     <li>Colour name (“<code>red</code>”, “<code>green</code>”, “<code>cornflowerblue</code>”, etc)</li>
 185     <li>#••• — shortened HTML colour: (“<code>#000</code>”, “<code>#fc0</code>”, etc)</li>
 186     <li>#•••••• — full length HTML colour: (“<code>#000000</code>”, “<code>#bd2300</code>”)</li>
 187     <li>rgb(•••, •••, •••) — red, green and blue channels’ values: (“<code>rgb(200,&nbsp;100,&nbsp;0)</code>”)</li>
 188     <li>rgb(•••%, •••%, •••%) — same as above, but in %: (“<code>rgb(100%,&nbsp;175%,&nbsp;0%)</code>”)</li>
 189     <li>rgba(•••, •••, •••, •••) — red, green and blue channels’ values: (“<code>rgba(200,&nbsp;100,&nbsp;0, .5)</code>”)</li>
 190     <li>rgba(•••%, •••%, •••%, •••%) — same as above, but in %: (“<code>rgba(100%,&nbsp;175%,&nbsp;0%, 50%)</code>”)</li>
 191     <li>hsb(•••, •••, •••) — hue, saturation and brightness values: (“<code>hsb(0.5,&nbsp;0.25,&nbsp;1)</code>”)</li>
 192     <li>hsb(•••%, •••%, •••%) — same as above, but in %</li>
 193     <li>hsba(•••, •••, •••, •••) — same as above, but with opacity</li>
 194     <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>
 195     <li>hsl(•••%, •••%, •••%) — same as above, but in %</li>
 196     <li>hsla(•••, •••, •••, •••) — same as above, but with opacity</li>
 197     <li>Optionally for hsb and hsl you could specify hue as a degree: “<code>hsl(240deg,&nbsp;1,&nbsp;.5)</code>” or, if you want to go fancy, “<code>hsl(240°,&nbsp;1,&nbsp;.5)</code>”</li>
 198 </ul>
 199 </div><div class="Element-click-section"><h3 id="Element.click" class="dr-method"><i class="dr-trixie">&#160;</i>Element.click(handler)<a href="#Element.click" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2343 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2343">&#x27ad;</a></h3>
 200 <div class="extra" id="Element.click-extra"></div></div><div class="dr-method"><p>Adds event handler for click for the element.
 201 </p>
 202 <p class="header">Parameters
 203 </p>
 204 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 205 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 206 <dd class="dr-description">handler for the event</dd>
 207 </dl>
 208 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 209 </div><div class="Element-clone-section"><h3 id="Element.clone" class="dr-method"><i class="dr-trixie">&#160;</i>Element.clone()<a href="#Element.clone" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3138 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3138">&#x27ad;</a></h3>
 210 <div class="extra" id="Element.clone-extra"></div></div><div class="dr-method"><p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">clone of a given element</span></p>
 211 </div><div class="Element-data-section"><h3 id="Element.data" class="dr-method"><i class="dr-trixie">&#160;</i>Element.data(key, [value])<a href="#Element.data" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2588 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2588">&#x27ad;</a></h3>
 212 <div class="extra" id="Element.data-extra"></div></div><div class="dr-method"><p>Adds or retrieves given value asociated with given key.
 213 See also <a href="#Element.removeData" class="dr-link">Element.removeData</a>
 214 </p>
 215 <p class="header">Parameters
 216 </p>
 217 <dl class="dr-parameters"><dt class="dr-param">key</dt>
 218 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 219 <dd class="dr-description">key to store data</dd>
 220 <dt class="dr-param optional">value</dt>
 221 <dd class="dr-optional">optional</dd>
 222 <dd class="dr-type"><em class="dr-type-any">any</em></dd>
 223 <dd class="dr-description">value to store</dd>
 224 </dl>
 225 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 226 <p>or, if value is not specified:
 227 </p>
 228 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-any">any</em> <span class="dr-description">value</span></p>
 229 <p class="header">Usage
 230 </p>
 231 <pre class="javascript code"><code><b>for</b> (<b>var</b> i<span class="s"> = </span><span class="d">0</span>, i &lt; <span class="d">5</span>, i++) {
 232     paper.circle(<span class="d">10</span><span class="s"> + </span><span class="d">15</span><span class="s"> * </span>i, <span class="d">10</span>, <span class="d">10</span>)
 233          .attr({fill: <i>"#<span class="d">000</span>"</i>})
 234          .data(<i>"i"</i>, i)
 235          .click(<b>function</b> () {
 236             alert(<b>this</b>.data(<i>"i"</i>));
 237          });
 238 }
 239 </code></pre>
 240 </div><div class="Element-dblclick-section"><h3 id="Element.dblclick" class="dr-method"><i class="dr-trixie">&#160;</i>Element.dblclick(handler)<a href="#Element.dblclick" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2362 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2362">&#x27ad;</a></h3>
 241 <div class="extra" id="Element.dblclick-extra"></div></div><div class="dr-method"><p>Adds event handler for double click for the element.
 242 </p>
 243 <p class="header">Parameters
 244 </p>
 245 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 246 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 247 <dd class="dr-description">handler for the event</dd>
 248 </dl>
 249 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 250 </div><div class="Element-drag-section"><h3 id="Element.drag" class="dr-method"><i class="dr-trixie">&#160;</i>Element.drag(onmove, onstart, onend, [mcontext], [scontext], [econtext])<a href="#Element.drag" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2680 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2680">&#x27ad;</a></h3>
 251 <div class="extra" id="Element.drag-extra"></div></div><div class="dr-method"><p>Adds event handlers for drag of the element.
 252 </p>
 253 <p class="header">Parameters
 254 </p>
 255 <dl class="dr-parameters"><dt class="dr-param">onmove</dt>
 256 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 257 <dd class="dr-description">handler for moving</dd>
 258 <dt class="dr-param">onstart</dt>
 259 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 260 <dd class="dr-description">handler for drag start</dd>
 261 <dt class="dr-param">onend</dt>
 262 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 263 <dd class="dr-description">handler for drag end</dd>
 264 <dt class="dr-param optional">mcontext</dt>
 265 <dd class="dr-optional">optional</dd>
 266 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 267 <dd class="dr-description">context for moving handler</dd>
 268 <dt class="dr-param optional">scontext</dt>
 269 <dd class="dr-optional">optional</dd>
 270 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 271 <dd class="dr-description">context for drag start handler</dd>
 272 <dt class="dr-param optional">econtext</dt>
 273 <dd class="dr-optional">optional</dd>
 274 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 275 <dd class="dr-description">context for drag end handler</dd>
 276 </dl>
 277 <p>Additionaly following <code>drag</code> events will be triggered: <code>drag.start.&lt;id></code> on start,
 278 <code>drag.end.&lt;id></code> on end and <code>drag.move.&lt;id></code> on every move. When element will be dragged over another element
 279 <code>drag.over.&lt;id></code> will be fired as well.
 280 </p>
 281 <p>Start event and start handler will be called in specified context or in context of the element with following parameters:
 282 </p>
 283 <ol class="dr-json"><li><span class="dr-json-key">x</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x position of the mouse</span>
 284 <li><span class="dr-json-key">y</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y position of the mouse</span>
 285 <li><span class="dr-json-key">event</span><span class="dr-type"><em class="dr-type-object">object</em></span><span class="dr-json-description">DOM event object</span>
 286 </ol>
 287 <p>Move event and move handler will be called in specified context or in context of the element with following parameters:
 288 </p>
 289 <ol class="dr-json"><li><span class="dr-json-key">dx</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">shift by x from the start point</span>
 290 <li><span class="dr-json-key">dy</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">shift by y from the start point</span>
 291 <li><span class="dr-json-key">x</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x position of the mouse</span>
 292 <li><span class="dr-json-key">y</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y position of the mouse</span>
 293 <li><span class="dr-json-key">event</span><span class="dr-type"><em class="dr-type-object">object</em></span><span class="dr-json-description">DOM event object</span>
 294 </ol>
 295 <p>End event and end handler will be called in specified context or in context of the element with following parameters:
 296 </p>
 297 <ol class="dr-json"><li><span class="dr-json-key">event</span><span class="dr-type"><em class="dr-type-object">object</em></span><span class="dr-json-description">DOM event object</span>
 298 </ol>
 299 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 300 </div><div class="Element-getBBox-section"><h3 id="Element.getBBox" class="dr-method"><i class="dr-trixie">&#160;</i>Element.getBBox(isWithoutTransform)<a href="#Element.getBBox" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3106 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3106">&#x27ad;</a></h3>
 301 <div class="extra" id="Element.getBBox-extra"></div></div><div class="dr-method"><p>Return bounding box for a given element
 302 </p>
 303 <p class="header">Parameters
 304 </p>
 305 <dl class="dr-parameters"><dt class="dr-param">isWithoutTransform</dt>
 306 <dd class="dr-type"><em class="dr-type-boolean">boolean</em></dd>
 307 <dd class="dr-description">flag, <code>true</code> if you want to have bounding box before transformations. Default is <code>false</code>.</dd>
 308 </dl>
 309 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Bounding box object:</span></p>
 310 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">top left corner x</span>
 311 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">top left corner y</span>
 312 <li><span class="dr-json-key">width:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">width</span>
 313 <li><span class="dr-json-key">height:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">height</span>
 314 </ol></li><li>}</li></ol>
 315 </div><div class="Element-getPointAtLength-section"><h3 id="Element.getPointAtLength" class="dr-method"><i class="dr-trixie">&#160;</i>Element.getPointAtLength(length)<a href="#Element.getPointAtLength" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3358 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3358">&#x27ad;</a></h3>
 316 <div class="extra" id="Element.getPointAtLength-extra"></div></div><div class="dr-method"><p>Return coordinates of the point located at the given length on the given path. Only works for element of “path” type.
 317 </p>
 318 <p class="header">Parameters
 319 </p>
 320 <dl class="dr-parameters"><dt class="dr-param">length</dt>
 321 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 322 <dd class="dr-description">&#160;</dd>
 323 </dl>
 324 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">representation of the point:</span></p>
 325 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate</span>
 326 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate</span>
 327 <li><span class="dr-json-key">alpha:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">angle of derivative</span>
 328 </ol></li><li>}</li></ol>
 329 </div><div class="Element-getSubpath-section"><h3 id="Element.getSubpath" class="dr-method"><i class="dr-trixie">&#160;</i>Element.getSubpath(from, to)<a href="#Element.getSubpath" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3375 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3375">&#x27ad;</a></h3>
 330 <div class="extra" id="Element.getSubpath-extra"></div></div><div class="dr-method"><p>Return subpath of a given element from given length to given length. Only works for element of “path” type.
 331 </p>
 332 <p class="header">Parameters
 333 </p>
 334 <dl class="dr-parameters"><dt class="dr-param">from</dt>
 335 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 336 <dd class="dr-description">position of the start of the segment</dd>
 337 <dt class="dr-param">to</dt>
 338 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 339 <dd class="dr-description">position of the end of the segment</dd>
 340 </dl>
 341 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">pathstring for the segment</span></p>
 342 </div><div class="Element-getTotalLength-section"><h3 id="Element.getTotalLength" class="dr-method"><i class="dr-trixie">&#160;</i>Element.getTotalLength()<a href="#Element.getTotalLength" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3334 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3334">&#x27ad;</a></h3>
 343 <div class="extra" id="Element.getTotalLength-extra"></div></div><div class="dr-method"><p>Returns length of the path in pixels. Only works for element of “path” type.
 344 </p>
 345 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">length.</span></p>
 346 </div><div class="Element-glow-section"><h3 id="Element.glow" class="dr-method"><i class="dr-trixie">&#160;</i>Element.glow([glow])<a href="#Element.glow" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3167 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3167">&#x27ad;</a></h3>
 347 <div class="extra" id="Element.glow-extra"></div></div><div class="dr-method"><p>Return set of elements that create glow-like effect around given element. See <a href="#Paper.set" class="dr-link">Paper.set</a>.
 348 </p>
 349 <p>Note: Glow is not connected to the element. If you change element attributes it won’t adjust itself.
 350 </p>
 351 <p class="header">Parameters
 352 </p>
 353 <dl class="dr-parameters"><dt class="dr-param optional">glow</dt>
 354 <dd class="dr-optional">optional</dd>
 355 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 356 <dd class="dr-description">parameters object with all properties optional:</dd>
 357 </dl>
 358 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">width</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">size of the glow, default is <code>10</code></span>
 359 <li><span class="dr-json-key">fill</span><span class="dr-type"><em class="dr-type-boolean">boolean</em></span><span class="dr-json-description">will it be filled, default is <code>false</code></span>
 360 <li><span class="dr-json-key">opacity</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">opacity, default is <code>0.5</code></span>
 361 <li><span class="dr-json-key">offsetx</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">horizontal offset, default is <code>0</code></span>
 362 <li><span class="dr-json-key">offsety</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">vertical offset, default is <code>0</code></span>
 363 <li><span class="dr-json-key">color</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">glow colour, default is <code>black</code></span>
 364 </ol></li><li>}</li></ol>
 365 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Paper.set" class="dr-link">Paper.set</a> of elements that represents glow</span></p>
 366 </div><div class="Element-hide-section"><h3 id="Element.hide" class="dr-method"><i class="dr-trixie">&#160;</i>Element.hide()<a href="#Element.hide" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 851 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L851">&#x27ad;</a></h3>
 367 <div class="extra" id="Element.hide-extra"></div></div><div class="dr-method"><p>Makes element invisible. See <a href="#Element.show" class="dr-link">Element.show</a>.
 368 </p>
 369 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 370 </div><div class="Element-hover-section"><h3 id="Element.hover" class="dr-method"><i class="dr-trixie">&#160;</i>Element.hover(f_in, f_out, [icontext], [ocontext])<a href="#Element.hover" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2634 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2634">&#x27ad;</a></h3>
 371 <div class="extra" id="Element.hover-extra"></div></div><div class="dr-method"><p>Adds event handlers for hover for the element.
 372 </p>
 373 <p class="header">Parameters
 374 </p>
 375 <dl class="dr-parameters"><dt class="dr-param">f_in</dt>
 376 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 377 <dd class="dr-description">handler for hover in</dd>
 378 <dt class="dr-param">f_out</dt>
 379 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 380 <dd class="dr-description">handler for hover out</dd>
 381 <dt class="dr-param optional">icontext</dt>
 382 <dd class="dr-optional">optional</dd>
 383 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 384 <dd class="dr-description">context for hover in handler</dd>
 385 <dt class="dr-param optional">ocontext</dt>
 386 <dd class="dr-optional">optional</dd>
 387 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 388 <dd class="dr-description">context for hover out handler</dd>
 389 </dl>
 390 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 391 </div><div class="Element-id-section"><h3 id="Element.id" class="dr-property"><i class="dr-trixie">&#160;</i>Element.id<a href="#Element.id" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 637 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L637">&#x27ad;</a></h3>
 392 <div class="extra" id="Element.id-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-number">number</em><p>Unique id of the element. Especially usesful when you want to listen to events of the element,
 393 because all events are fired in format <code>&lt;module>.&lt;action>.&lt;id></code>. Also useful for <a href="#Paper.getById" class="dr-link">Paper.getById</a> method.
 394 </p>
 395 </div><div class="Element-insertAfter-section"><h3 id="Element.insertAfter" class="dr-method"><i class="dr-trixie">&#160;</i>Element.insertAfter()<a href="#Element.insertAfter" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1083 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1083">&#x27ad;</a></h3>
 396 <div class="extra" id="Element.insertAfter-extra"></div></div><div class="dr-method"><p>Inserts current object after the given one.
 397 </p>
 398 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 399 </div><div class="Element-insertBefore-section"><h3 id="Element.insertBefore" class="dr-method"><i class="dr-trixie">&#160;</i>Element.insertBefore()<a href="#Element.insertBefore" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1103 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1103">&#x27ad;</a></h3>
 400 <div class="extra" id="Element.insertBefore-extra"></div></div><div class="dr-method"><p>Inserts current object before the given one.
 401 </p>
 402 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 403 </div><div class="Element-mousedown-section"><h3 id="Element.mousedown" class="dr-method"><i class="dr-trixie">&#160;</i>Element.mousedown(handler)<a href="#Element.mousedown" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2381 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2381">&#x27ad;</a></h3>
 404 <div class="extra" id="Element.mousedown-extra"></div></div><div class="dr-method"><p>Adds event handler for mousedown for the element.
 405 </p>
 406 <p class="header">Parameters
 407 </p>
 408 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 409 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 410 <dd class="dr-description">handler for the event</dd>
 411 </dl>
 412 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 413 </div><div class="Element-mousemove-section"><h3 id="Element.mousemove" class="dr-method"><i class="dr-trixie">&#160;</i>Element.mousemove(handler)<a href="#Element.mousemove" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2400 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2400">&#x27ad;</a></h3>
 414 <div class="extra" id="Element.mousemove-extra"></div></div><div class="dr-method"><p>Adds event handler for mousemove for the element.
 415 </p>
 416 <p class="header">Parameters
 417 </p>
 418 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 419 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 420 <dd class="dr-description">handler for the event</dd>
 421 </dl>
 422 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 423 </div><div class="Element-mouseout-section"><h3 id="Element.mouseout" class="dr-method"><i class="dr-trixie">&#160;</i>Element.mouseout(handler)<a href="#Element.mouseout" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2419 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2419">&#x27ad;</a></h3>
 424 <div class="extra" id="Element.mouseout-extra"></div></div><div class="dr-method"><p>Adds event handler for mouseout for the element.
 425 </p>
 426 <p class="header">Parameters
 427 </p>
 428 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 429 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 430 <dd class="dr-description">handler for the event</dd>
 431 </dl>
 432 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 433 </div><div class="Element-mouseover-section"><h3 id="Element.mouseover" class="dr-method"><i class="dr-trixie">&#160;</i>Element.mouseover(handler)<a href="#Element.mouseover" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2438 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2438">&#x27ad;</a></h3>
 434 <div class="extra" id="Element.mouseover-extra"></div></div><div class="dr-method"><p>Adds event handler for mouseover for the element.
 435 </p>
 436 <p class="header">Parameters
 437 </p>
 438 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 439 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 440 <dd class="dr-description">handler for the event</dd>
 441 </dl>
 442 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 443 </div><div class="Element-mouseup-section"><h3 id="Element.mouseup" class="dr-method"><i class="dr-trixie">&#160;</i>Element.mouseup(handler)<a href="#Element.mouseup" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2457 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2457">&#x27ad;</a></h3>
 444 <div class="extra" id="Element.mouseup-extra"></div></div><div class="dr-method"><p>Adds event handler for mouseup for the element.
 445 </p>
 446 <p class="header">Parameters
 447 </p>
 448 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 449 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 450 <dd class="dr-description">handler for the event</dd>
 451 </dl>
 452 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 453 </div><div class="Element-next-section"><h3 id="Element.next" class="dr-property"><i class="dr-trixie">&#160;</i>Element.next<a href="#Element.next" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 680 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L680">&#x27ad;</a></h3>
 454 <div class="extra" id="Element.next-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Reference to the next element in the hierarchy.
 455 </p>
 456 </div><div class="Element-node-section"><h3 id="Element.node" class="dr-property"><i class="dr-trixie">&#160;</i>Element.node<a href="#Element.node" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 616 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L616">&#x27ad;</a></h3>
 457 <div class="extra" id="Element.node-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Gives you a reference to the DOM object, so you can assign event handlers or just mess around.
 458 Note: Don’t mess with it.
 459 </p>
 460 <p class="header">Usage
 461 </p>
 462 <pre class="javascript code"><code><span class="c">// draw a circle at coordinate <span class="d">10</span>,<span class="d">10</span> <b>with</b> radius of <span class="d">10</span></span>
 463 <b>var</b> c<span class="s"> = </span>paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">10</span>);
 464 c.node.onclick<span class="s"> = </span><b>function</b> () {
 465     c.attr(<i>"fill"</i>, <i>"red"</i>);
 466 };
 467 </code></pre>
 468 </div><div class="Element-onDragOver-section"><h3 id="Element.onDragOver" class="dr-method"><i class="dr-trixie">&#160;</i>Element.onDragOver(f)<a href="#Element.onDragOver" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2707 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2707">&#x27ad;</a></h3>
 469 <div class="extra" id="Element.onDragOver-extra"></div></div><div class="dr-method"><p>Shortcut for assigning event handler for <code>drag.over.&lt;id></code> event, where id is id of the element (see <a href="#Element.id" class="dr-link">Element.id</a>).
 470 </p>
 471 <p class="header">Parameters
 472 </p>
 473 <dl class="dr-parameters"><dt class="dr-param">f</dt>
 474 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 475 <dd class="dr-description">handler for event, first argument would be the element you are dragging over</dd>
 476 </dl>
 477 </div><div class="Element-paper-section"><h3 id="Element.paper" class="dr-property"><i class="dr-trixie">&#160;</i>Element.paper<a href="#Element.paper" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 653 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L653">&#x27ad;</a></h3>
 478 <div class="extra" id="Element.paper-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Internal reference to “paper” where object drawn. Mainly for use in plugins and element extensions.
 479 </p>
 480 <p class="header">Usage
 481 </p>
 482 <pre class="javascript code"><code>Raphael.el.cross<span class="s"> = </span><b>function</b> () {
 483     <b>this</b>.attr({fill: <i>"red"</i>});
 484     <b>this</b>.paper.path(<i>"M10,10L50,50M50,10L10,<span class="d">50</span>"</i>)
 485         .attr({stroke: <i>"red"</i>});
 486 }
 487 </code></pre>
 488 </div><div class="Element-pause-section"><h3 id="Element.pause" class="dr-method"><i class="dr-trixie">&#160;</i>Element.pause([anim])<a href="#Element.pause" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4090 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4090">&#x27ad;</a></h3>
 489 <div class="extra" id="Element.pause-extra"></div></div><div class="dr-method"><p>Stops animation of the element with ability to resume it later on.
 490 </p>
 491 <p class="header">Parameters
 492 </p>
 493 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 494 <dd class="dr-optional">optional</dd>
 495 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 496 <dd class="dr-description">animation object</dd>
 497 </dl>
 498 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element</span></p>
 499 </div><div class="Element-prev-section"><h3 id="Element.prev" class="dr-property"><i class="dr-trixie">&#160;</i>Element.prev<a href="#Element.prev" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 671 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L671">&#x27ad;</a></h3>
 500 <div class="extra" id="Element.prev-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Reference to the previous element in the hierarchy.
 501 </p>
 502 </div><div class="Element-raphael-section"><h3 id="Element.raphael" class="dr-property"><i class="dr-trixie">&#160;</i>Element.raphael<a href="#Element.raphael" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 629 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L629">&#x27ad;</a></h3>
 503 <div class="extra" id="Element.raphael-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Internal reference to <a href="#Raphael" class="dr-link">Raphael</a> object. In case it is not available.
 504 </p>
 505 <p class="header">Usage
 506 </p>
 507 <pre class="javascript code"><code>Raphael.el.red<span class="s"> = </span><b>function</b> () {
 508     <b>var</b> hsb<span class="s"> = </span><b>this</b>.paper.raphael.rgb2hsb(<b>this</b>.attr(<i>"fill"</i>));
 509     hsb.h<span class="s"> = </span><span class="d">1</span>;
 510     <b>this</b>.attr({fill: <b>this</b>.paper.raphael.hsb2rgb(hsb).hex});
 511 }
 512 </code></pre>
 513 </div><div class="Element-remove-section"><h3 id="Element.remove" class="dr-method"><i class="dr-trixie">&#160;</i>Element.remove()<a href="#Element.remove" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 872 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L872">&#x27ad;</a></h3>
 514 <div class="extra" id="Element.remove-extra"></div></div><div class="dr-method"><p>Removes element form the paper.
 515 </p>
 516 </div><div class="Element-removeData-section"><h3 id="Element.removeData" class="dr-method"><i class="dr-trixie">&#160;</i>Element.removeData([key])<a href="#Element.removeData" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2614 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2614">&#x27ad;</a></h3>
 517 <div class="extra" id="Element.removeData-extra"></div></div><div class="dr-method"><p>Removes value associated with an element by given key.
 518 If key is not provided, removes all the data of the element.
 519 </p>
 520 <p class="header">Parameters
 521 </p>
 522 <dl class="dr-parameters"><dt class="dr-param optional">key</dt>
 523 <dd class="dr-optional">optional</dd>
 524 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 525 <dd class="dr-description">key</dd>
 526 </dl>
 527 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 528 </div><div class="Element-resume-section"><h3 id="Element.resume" class="dr-method"><i class="dr-trixie">&#160;</i>Element.resume([anim])<a href="#Element.resume" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4110 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4110">&#x27ad;</a></h3>
 529 <div class="extra" id="Element.resume-extra"></div></div><div class="dr-method"><p>Resumes animation if it was paused with <a href="#Element.pause" class="dr-link">Element.pause</a> method.
 530 </p>
 531 <p class="header">Parameters
 532 </p>
 533 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 534 <dd class="dr-optional">optional</dd>
 535 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 536 <dd class="dr-description">animation object</dd>
 537 </dl>
 538 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element</span></p>
 539 </div><div class="Element-rotate-section"><h3 id="Element.rotate" class="dr-method"><i class="dr-trixie">&#160;</i>Element.rotate(deg, [cx], [cy])<a href="#Element.rotate" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 712 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L712">&#x27ad;</a></h3>
 540 <div class="extra" id="Element.rotate-extra"></div></div><div class="dr-method"><p>Adds rotation by given angle around given point to the list of
 541 transformations of the element.
 542 </p>
 543 <p class="header">Parameters
 544 </p>
 545 <dl class="dr-parameters"><dt class="dr-param">deg</dt>
 546 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 547 <dd class="dr-description">angle in degrees</dd>
 548 <dt class="dr-param optional">cx</dt>
 549 <dd class="dr-optional">optional</dd>
 550 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 551 <dd class="dr-description">x coordinate of the centre of rotation</dd>
 552 <dt class="dr-param optional">cy</dt>
 553 <dd class="dr-optional">optional</dd>
 554 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 555 <dd class="dr-description">y coordinate of the centre of rotation</dd>
 556 </dl>
 557 <p>If cx <em class="amp">&amp;</em> cy aren’t specified centre of the shape is used as a point of rotation.
 558 </p>
 559 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 560 </div><div class="Element-scale-section"><h3 id="Element.scale" class="dr-method"><i class="dr-trixie">&#160;</i>Element.scale(sx, sy, [cx], [cy])<a href="#Element.scale" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 745 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L745">&#x27ad;</a></h3>
 561 <div class="extra" id="Element.scale-extra"></div></div><div class="dr-method"><p>Adds scale by given amount relative to given point to the list of
 562 transformations of the element.
 563 </p>
 564 <p class="header">Parameters
 565 </p>
 566 <dl class="dr-parameters"><dt class="dr-param">sx</dt>
 567 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 568 <dd class="dr-description">horisontal scale amount</dd>
 569 <dt class="dr-param">sy</dt>
 570 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 571 <dd class="dr-description">vertical scale amount</dd>
 572 <dt class="dr-param optional">cx</dt>
 573 <dd class="dr-optional">optional</dd>
 574 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 575 <dd class="dr-description">x coordinate of the centre of scale</dd>
 576 <dt class="dr-param optional">cy</dt>
 577 <dd class="dr-optional">optional</dd>
 578 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 579 <dd class="dr-description">y coordinate of the centre of scale</dd>
 580 </dl>
 581 <p>If cx <em class="amp">&amp;</em> cy aren’t specified centre of the shape is used instead.
 582 </p>
 583 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 584 </div><div class="Element-setTime-section"><h3 id="Element.setTime" class="dr-method"><i class="dr-trixie">&#160;</i>Element.setTime(anim, value)<a href="#Element.setTime" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4023 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4023">&#x27ad;</a></h3>
 585 <div class="extra" id="Element.setTime-extra"></div></div><div class="dr-method"><p>Sets the status of animation of the element in milliseconds. Similar to <a href="#Element.status" class="dr-link">Element.status</a> method.
 586 </p>
 587 <p class="header">Parameters
 588 </p>
 589 <dl class="dr-parameters"><dt class="dr-param">anim</dt>
 590 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 591 <dd class="dr-description">animation object</dd>
 592 <dt class="dr-param">value</dt>
 593 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 594 <dd class="dr-description">number of milliseconds from the beginning of the animation</dd>
 595 </dl>
 596 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element if <code>value</code> is specified</span></p>
 597 <p>Note, that during animation following events are triggered:
 598 </p>
 599 <p>On each animation frame event <code>anim.frame.&lt;id></code>, on start <code>anim.start.&lt;id></code> and on end <code>anim.finish.&lt;id></code>.
 600 </p>
 601 </div><div class="Element-show-section"><h3 id="Element.show" class="dr-method"><i class="dr-trixie">&#160;</i>Element.show()<a href="#Element.show" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 862 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L862">&#x27ad;</a></h3>
 602 <div class="extra" id="Element.show-extra"></div></div><div class="dr-method"><p>Makes element visible. See <a href="#Element.hide" class="dr-link">Element.hide</a>.
 603 </p>
 604 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 605 </div><div class="Element-status-section"><h3 id="Element.status" class="dr-method"><i class="dr-trixie">&#160;</i>Element.status([anim], [value])<a href="#Element.status" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4050 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4050">&#x27ad;</a></h3>
 606 <div class="extra" id="Element.status-extra"></div></div><div class="dr-method"><p>Gets or sets the status of animation of the element.
 607 </p>
 608 <p class="header">Parameters
 609 </p>
 610 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 611 <dd class="dr-optional">optional</dd>
 612 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 613 <dd class="dr-description">animation object</dd>
 614 <dt class="dr-param optional">value</dt>
 615 <dd class="dr-optional">optional</dd>
 616 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 617 <dd class="dr-description">0 – 1. If specified, method works like a setter and sets the status of a given animation to the value. This will cause animation to jump to the given position.</dd>
 618 </dl>
 619 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">status</span></p>
 620 <p>or
 621 </p>
 622 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">status if <code>anim</code> is not specified. Array of objects in format:</span></p>
 623 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">anim:</span><span class="dr-type"><em class="dr-type-object">object</em></span><span class="dr-json-description">animation object</span>
 624 <li><span class="dr-json-key">status:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">status</span>
 625 </ol></li><li>}</li></ol>
 626 <p>or
 627 </p>
 628 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element if <code>value</code> is specified</span></p>
 629 </div><div class="Element-stop-section"><h3 id="Element.stop" class="dr-method"><i class="dr-trixie">&#160;</i>Element.stop([anim])<a href="#Element.stop" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4132 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4132">&#x27ad;</a></h3>
 630 <div class="extra" id="Element.stop-extra"></div></div><div class="dr-method"><p>Stops animation of the element.
 631 </p>
 632 <p class="header">Parameters
 633 </p>
 634 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 635 <dd class="dr-optional">optional</dd>
 636 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 637 <dd class="dr-description">animation object</dd>
 638 </dl>
 639 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element</span></p>
 640 </div><div class="Element-toBack-section"><h3 id="Element.toBack" class="dr-method"><i class="dr-trixie">&#160;</i>Element.toBack()<a href="#Element.toBack" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1065 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1065">&#x27ad;</a></h3>
 641 <div class="extra" id="Element.toBack-extra"></div></div><div class="dr-method"><p>Moves the element so it is the furthest from the viewer’s eyes, behind other elements.
 642 </p>
 643 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 644 </div><div class="Element-toFront-section"><h3 id="Element.toFront" class="dr-method"><i class="dr-trixie">&#160;</i>Element.toFront()<a href="#Element.toFront" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1049 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1049">&#x27ad;</a></h3>
 645 <div class="extra" id="Element.toFront-extra"></div></div><div class="dr-method"><p>Moves the element so it is the closest to the viewer’s eyes, on top of other elements.
 646 </p>
 647 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 648 </div><div class="Element-touchcancel-section"><h3 id="Element.touchcancel" class="dr-method"><i class="dr-trixie">&#160;</i>Element.touchcancel(handler)<a href="#Element.touchcancel" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2533 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2533">&#x27ad;</a></h3>
 649 <div class="extra" id="Element.touchcancel-extra"></div></div><div class="dr-method"><p>Adds event handler for touchcancel for the element.
 650 </p>
 651 <p class="header">Parameters
 652 </p>
 653 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 654 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 655 <dd class="dr-description">handler for the event</dd>
 656 </dl>
 657 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 658 </div><div class="Element-touchend-section"><h3 id="Element.touchend" class="dr-method"><i class="dr-trixie">&#160;</i>Element.touchend(handler)<a href="#Element.touchend" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2514 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2514">&#x27ad;</a></h3>
 659 <div class="extra" id="Element.touchend-extra"></div></div><div class="dr-method"><p>Adds event handler for touchend for the element.
 660 </p>
 661 <p class="header">Parameters
 662 </p>
 663 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 664 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 665 <dd class="dr-description">handler for the event</dd>
 666 </dl>
 667 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 668 </div><div class="Element-touchmove-section"><h3 id="Element.touchmove" class="dr-method"><i class="dr-trixie">&#160;</i>Element.touchmove(handler)<a href="#Element.touchmove" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2495 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2495">&#x27ad;</a></h3>
 669 <div class="extra" id="Element.touchmove-extra"></div></div><div class="dr-method"><p>Adds event handler for touchmove for the element.
 670 </p>
 671 <p class="header">Parameters
 672 </p>
 673 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 674 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 675 <dd class="dr-description">handler for the event</dd>
 676 </dl>
 677 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 678 </div><div class="Element-touchstart-section"><h3 id="Element.touchstart" class="dr-method"><i class="dr-trixie">&#160;</i>Element.touchstart(handler)<a href="#Element.touchstart" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2476 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2476">&#x27ad;</a></h3>
 679 <div class="extra" id="Element.touchstart-extra"></div></div><div class="dr-method"><p>Adds event handler for touchstart for the element.
 680 </p>
 681 <p class="header">Parameters
 682 </p>
 683 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 684 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 685 <dd class="dr-description">handler for the event</dd>
 686 </dl>
 687 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 688 </div><div class="Element-transform-section"><h3 id="Element.transform" class="dr-method"><i class="dr-trixie">&#160;</i>Element.transform([tstr])<a href="#Element.transform" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 826 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L826">&#x27ad;</a></h3>
 689 <div class="extra" id="Element.transform-extra"></div></div><div class="dr-method"><p>Adds transformation to the element which is separate to other attributes,
 690 i.e. translation doesn’t change <code>x</code> or <code>y</code> of the rectange. The format
 691 of transformation string is similar to the path string syntax:
 692 </p>
 693 <pre class="javascript code"><code><i>"t100,100r30,<span class="d">100</span>,100s2,<span class="d">2</span>,<span class="d">100</span>,100r45s1<span class="d">.5</span>"</i>
 694 </code></pre>
 695 <p>Each letter is a command. There are four commands: <code>t</code> is for translate, <code>r</code> is for rotate, <code>s</code> is for
 696 scale and <code>m</code> is for matrix.
 697 </p>
 698 <p>There are also alternative “absolute” translation, rotation and scale: <code>T</code>, <code>R</code> and <code>S</code>. They will not take previous transformation into account. For example, <code>...T100,0</code> will always move element 100 px horisontally, while <code>...t100,0</code> could move it vertically if there is <code>r90</code> before. Just compare results of <code>r90t100,0</code> and <code>r90T100,0</code>.
 699 </p>
 700 <p>So, the example line above could be read like “translate by 100, 100; rotate 30° around 100, 100; scale twice around 100, 100;
 701 rotate 45° around centre; scale 1.5 times relative to centre”. As you can see rotate and scale commands have origin
 702 coordinates as optional parameters, the default is the centre point of the element.
 703 Matrix accepts six parameters.
 704 </p>
 705 <p class="header">Usage
 706 </p>
 707 <pre class="javascript code"><code><b>var</b> el<span class="s"> = </span>paper.rect(<span class="d">10</span>, <span class="d">20</span>, <span class="d">300</span>, <span class="d">200</span>);
 708 <span class="c">// translate <span class="d">100</span>, <span class="d">100</span>, rotate <span class="d">45</span>°, translate -<span class="d">100</span>, <span class="d">0</span></span>
 709 el.transform(<i>"t100,100r45t-<span class="d">100</span>,<span class="d">0</span>"</i>);
 710 <span class="c">// <b>if</b> you want you can append or prepend transformations</span>
 711 el.transform(<i>"...t50,<span class="d">50</span>"</i>);
 712 el.transform(<i>"s2..."</i>);
 713 <span class="c">// or even wrap</span>
 714 el.transform(<i>"t50,<span class="d">50</span>...t-<span class="d">50</span>-<span class="d">50</span>"</i>);
 715 <span class="c">// to reset transformation call method <b>with</b> empty string</span>
 716 el.transform(<i>""</i>);
 717 <span class="c">// to get current value call it without parameters</span>
 718 console.log(el.transform());
 719 </code></pre>
 720 <p class="header">Parameters
 721 </p>
 722 <dl class="dr-parameters"><dt class="dr-param optional">tstr</dt>
 723 <dd class="dr-optional">optional</dd>
 724 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 725 <dd class="dr-description">transformation string</dd>
 726 </dl>
 727 <p>If tstr isn’t specified
 728 </p>
 729 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">current transformation string</span></p>
 730 <p>else
 731 </p>
 732 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 733 </div><div class="Element-translate-section"><h3 id="Element.translate" class="dr-method"><i class="dr-trixie">&#160;</i>Element.translate(dx, dy)<a href="#Element.translate" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 776 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L776">&#x27ad;</a></h3>
 734 <div class="extra" id="Element.translate-extra"></div></div><div class="dr-method"><p>Adds translation by given amount to the list of transformations of the element.
 735 </p>
 736 <p class="header">Parameters
 737 </p>
 738 <dl class="dr-parameters"><dt class="dr-param">dx</dt>
 739 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 740 <dd class="dr-description">horisontal shift</dd>
 741 <dt class="dr-param">dy</dt>
 742 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 743 <dd class="dr-description">vertical shift</dd>
 744 </dl>
 745 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 746 </div><div class="Element-unclick-section"><h3 id="Element.unclick" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unclick(handler)<a href="#Element.unclick" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2352 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2352">&#x27ad;</a></h3>
 747 <div class="extra" id="Element.unclick-extra"></div></div><div class="dr-method"><p>Removes event handler for click for the element.
 748 </p>
 749 <p class="header">Parameters
 750 </p>
 751 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 752 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 753 <dd class="dr-description">handler for the event</dd>
 754 </dl>
 755 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 756 </div><div class="Element-undblclick-section"><h3 id="Element.undblclick" class="dr-method"><i class="dr-trixie">&#160;</i>Element.undblclick(handler)<a href="#Element.undblclick" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2371 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2371">&#x27ad;</a></h3>
 757 <div class="extra" id="Element.undblclick-extra"></div></div><div class="dr-method"><p>Removes event handler for double click for the element.
 758 </p>
 759 <p class="header">Parameters
 760 </p>
 761 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 762 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 763 <dd class="dr-description">handler for the event</dd>
 764 </dl>
 765 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 766 </div><div class="Element-undrag-section"><h3 id="Element.undrag" class="dr-method"><i class="dr-trixie">&#160;</i>Element.undrag()<a href="#Element.undrag" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2716 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2716">&#x27ad;</a></h3>
 767 <div class="extra" id="Element.undrag-extra"></div></div><div class="dr-method"><p>Removes all drag event handlers from given element.
 768 </p>
 769 </div><div class="Element-unhover-section"><h3 id="Element.unhover" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unhover(f_in, f_out)<a href="#Element.unhover" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2647 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2647">&#x27ad;</a></h3>
 770 <div class="extra" id="Element.unhover-extra"></div></div><div class="dr-method"><p>Removes event handlers for hover for the element.
 771 </p>
 772 <p class="header">Parameters
 773 </p>
 774 <dl class="dr-parameters"><dt class="dr-param">f_in</dt>
 775 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 776 <dd class="dr-description">handler for hover in</dd>
 777 <dt class="dr-param">f_out</dt>
 778 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 779 <dd class="dr-description">handler for hover out</dd>
 780 </dl>
 781 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 782 </div><div class="Element-unmousedown-section"><h3 id="Element.unmousedown" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unmousedown(handler)<a href="#Element.unmousedown" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2390 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2390">&#x27ad;</a></h3>
 783 <div class="extra" id="Element.unmousedown-extra"></div></div><div class="dr-method"><p>Removes event handler for mousedown for the element.
 784 </p>
 785 <p class="header">Parameters
 786 </p>
 787 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 788 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 789 <dd class="dr-description">handler for the event</dd>
 790 </dl>
 791 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 792 </div><div class="Element-unmousemove-section"><h3 id="Element.unmousemove" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unmousemove(handler)<a href="#Element.unmousemove" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2409 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2409">&#x27ad;</a></h3>
 793 <div class="extra" id="Element.unmousemove-extra"></div></div><div class="dr-method"><p>Removes event handler for mousemove for the element.
 794 </p>
 795 <p class="header">Parameters
 796 </p>
 797 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 798 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 799 <dd class="dr-description">handler for the event</dd>
 800 </dl>
 801 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 802 </div><div class="Element-unmouseout-section"><h3 id="Element.unmouseout" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unmouseout(handler)<a href="#Element.unmouseout" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2428 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2428">&#x27ad;</a></h3>
 803 <div class="extra" id="Element.unmouseout-extra"></div></div><div class="dr-method"><p>Removes event handler for mouseout for the element.
 804 </p>
 805 <p class="header">Parameters
 806 </p>
 807 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 808 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 809 <dd class="dr-description">handler for the event</dd>
 810 </dl>
 811 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 812 </div><div class="Element-unmouseover-section"><h3 id="Element.unmouseover" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unmouseover(handler)<a href="#Element.unmouseover" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2447 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2447">&#x27ad;</a></h3>
 813 <div class="extra" id="Element.unmouseover-extra"></div></div><div class="dr-method"><p>Removes event handler for mouseover for the element.
 814 </p>
 815 <p class="header">Parameters
 816 </p>
 817 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 818 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 819 <dd class="dr-description">handler for the event</dd>
 820 </dl>
 821 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 822 </div><div class="Element-unmouseup-section"><h3 id="Element.unmouseup" class="dr-method"><i class="dr-trixie">&#160;</i>Element.unmouseup(handler)<a href="#Element.unmouseup" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2466 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2466">&#x27ad;</a></h3>
 823 <div class="extra" id="Element.unmouseup-extra"></div></div><div class="dr-method"><p>Removes event handler for mouseup for the element.
 824 </p>
 825 <p class="header">Parameters
 826 </p>
 827 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 828 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 829 <dd class="dr-description">handler for the event</dd>
 830 </dl>
 831 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 832 </div><div class="Element-untouchcancel-section"><h3 id="Element.untouchcancel" class="dr-method"><i class="dr-trixie">&#160;</i>Element.untouchcancel(handler)<a href="#Element.untouchcancel" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2542 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2542">&#x27ad;</a></h3>
 833 <div class="extra" id="Element.untouchcancel-extra"></div></div><div class="dr-method"><p>Removes event handler for touchcancel for the element.
 834 </p>
 835 <p class="header">Parameters
 836 </p>
 837 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 838 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 839 <dd class="dr-description">handler for the event</dd>
 840 </dl>
 841 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 842 </div><div class="Element-untouchend-section"><h3 id="Element.untouchend" class="dr-method"><i class="dr-trixie">&#160;</i>Element.untouchend(handler)<a href="#Element.untouchend" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2523 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2523">&#x27ad;</a></h3>
 843 <div class="extra" id="Element.untouchend-extra"></div></div><div class="dr-method"><p>Removes event handler for touchend for the element.
 844 </p>
 845 <p class="header">Parameters
 846 </p>
 847 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 848 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 849 <dd class="dr-description">handler for the event</dd>
 850 </dl>
 851 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 852 </div><div class="Element-untouchmove-section"><h3 id="Element.untouchmove" class="dr-method"><i class="dr-trixie">&#160;</i>Element.untouchmove(handler)<a href="#Element.untouchmove" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2504 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2504">&#x27ad;</a></h3>
 853 <div class="extra" id="Element.untouchmove-extra"></div></div><div class="dr-method"><p>Removes event handler for touchmove for the element.
 854 </p>
 855 <p class="header">Parameters
 856 </p>
 857 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 858 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 859 <dd class="dr-description">handler for the event</dd>
 860 </dl>
 861 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 862 </div><div class="Element-untouchstart-section"><h3 id="Element.untouchstart" class="dr-method"><i class="dr-trixie">&#160;</i>Element.untouchstart(handler)<a href="#Element.untouchstart" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2485 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2485">&#x27ad;</a></h3>
 863 <div class="extra" id="Element.untouchstart-extra"></div></div><div class="dr-method"><p>Removes event handler for touchstart for the element.
 864 </p>
 865 <p class="header">Parameters
 866 </p>
 867 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 868 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 869 <dd class="dr-description">handler for the event</dd>
 870 </dl>
 871 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Element" class="dr-link">Element</a></span></p>
 872 </div><div class="Matrix-section"><h2 id="Matrix" class="undefined"><i class="dr-trixie">&#160;</i>Matrix<a href="#Matrix" title="Link to this section" class="dr-hash">&#x2693;</a></h2>
 873 <div class="extra" id="Matrix-extra"></div></div><div class="Matrix-add-section"><h3 id="Matrix.add" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.add(a, b, c, d, e, f, matrix)<a href="#Matrix.add" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1973 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1973">&#x27ad;</a></h3>
 874 <div class="extra" id="Matrix.add-extra"></div></div><div class="dr-method"><p>Adds given matrix to existing one.
 875 </p>
 876 <p class="header">Parameters
 877 </p>
 878 <dl class="dr-parameters"><dt class="dr-param">a</dt>
 879 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 880 <dd class="dr-description">&#160;</dd>
 881 <dt class="dr-param">b</dt>
 882 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 883 <dd class="dr-description">&#160;</dd>
 884 <dt class="dr-param">c</dt>
 885 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 886 <dd class="dr-description">&#160;</dd>
 887 <dt class="dr-param">d</dt>
 888 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 889 <dd class="dr-description">&#160;</dd>
 890 <dt class="dr-param">e</dt>
 891 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 892 <dd class="dr-description">&#160;</dd>
 893 <dt class="dr-param">f</dt>
 894 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 895 <dd class="dr-description">&#160;</dd>
 896 <dt class="dr-param">matrix</dt>
 897 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 898 <dd class="dr-description"><a href="#Matrix" class="dr-link">Matrix</a></dd>
 899 </dl>
 900 </div><div class="Matrix-clone-section"><h3 id="Matrix.clone" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.clone()<a href="#Matrix.clone" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2018 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2018">&#x27ad;</a></h3>
 901 <div class="extra" id="Matrix.clone-extra"></div></div><div class="dr-method"><p>Returns copy of the matrix
 902 </p>
 903 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Matrix" class="dr-link">Matrix</a></span></p>
 904 </div><div class="Matrix-invert-section"><h3 id="Matrix.invert" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.invert()<a href="#Matrix.invert" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2006 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2006">&#x27ad;</a></h3>
 905 <div class="extra" id="Matrix.invert-extra"></div></div><div class="dr-method"><p>Returns inverted version of the matrix
 906 </p>
 907 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Matrix" class="dr-link">Matrix</a></span></p>
 908 </div><div class="Matrix-rotate-section"><h3 id="Matrix.rotate" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.rotate(a, x, y)<a href="#Matrix.rotate" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2060 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2060">&#x27ad;</a></h3>
 909 <div class="extra" id="Matrix.rotate-extra"></div></div><div class="dr-method"><p>Rotates the matrix
 910 </p>
 911 <p class="header">Parameters
 912 </p>
 913 <dl class="dr-parameters"><dt class="dr-param">a</dt>
 914 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 915 <dd class="dr-description">&#160;</dd>
 916 <dt class="dr-param">x</dt>
 917 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 918 <dd class="dr-description">&#160;</dd>
 919 <dt class="dr-param">y</dt>
 920 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 921 <dd class="dr-description">&#160;</dd>
 922 </dl>
 923 </div><div class="Matrix-scale-section"><h3 id="Matrix.scale" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.scale(x, [y], [cx], [cy])<a href="#Matrix.scale" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2044 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2044">&#x27ad;</a></h3>
 924 <div class="extra" id="Matrix.scale-extra"></div></div><div class="dr-method"><p>Scales the matrix
 925 </p>
 926 <p class="header">Parameters
 927 </p>
 928 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 929 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 930 <dd class="dr-description">&#160;</dd>
 931 <dt class="dr-param optional">y</dt>
 932 <dd class="dr-optional">optional</dd>
 933 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 934 <dd class="dr-description">&#160;</dd>
 935 <dt class="dr-param optional">cx</dt>
 936 <dd class="dr-optional">optional</dd>
 937 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 938 <dd class="dr-description">&#160;</dd>
 939 <dt class="dr-param optional">cy</dt>
 940 <dd class="dr-optional">optional</dd>
 941 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 942 <dd class="dr-description">&#160;</dd>
 943 </dl>
 944 </div><div class="Matrix-split-section"><h3 id="Matrix.split" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.split()<a href="#Matrix.split" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2133 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2133">&#x27ad;</a></h3>
 945 <div class="extra" id="Matrix.split-extra"></div></div><div class="dr-method"><p>Splits matrix into primitive transformations
 946 </p>
 947 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">in format:</span></p>
 948 <ol class="dr-json"><li><span class="dr-json-key">dx</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">translation by x</span>
 949 <li><span class="dr-json-key">dy</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">translation by y</span>
 950 <li><span class="dr-json-key">scalex</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">scale by x</span>
 951 <li><span class="dr-json-key">scaley</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">scale by y</span>
 952 <li><span class="dr-json-key">shear</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">shear</span>
 953 <li><span class="dr-json-key">rotate</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">rotation in deg</span>
 954 <li><span class="dr-json-key">isSimple</span><span class="dr-type"><em class="dr-type-boolean">boolean</em></span><span class="dr-json-description">could it be represented via simple transformations</span>
 955 </ol>
 956 </div><div class="Matrix-toTransformString-section"><h3 id="Matrix.toTransformString" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.toTransformString()<a href="#Matrix.toTransformString" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2175 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2175">&#x27ad;</a></h3>
 957 <div class="extra" id="Matrix.toTransformString-extra"></div></div><div class="dr-method"><p>Return transform string that represents given matrix
 958 </p>
 959 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">transform string</span></p>
 960 </div><div class="Matrix-translate-section"><h3 id="Matrix.translate" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.translate(x, y)<a href="#Matrix.translate" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2030 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2030">&#x27ad;</a></h3>
 961 <div class="extra" id="Matrix.translate-extra"></div></div><div class="dr-method"><p>Translate the matrix
 962 </p>
 963 <p class="header">Parameters
 964 </p>
 965 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 966 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 967 <dd class="dr-description">&#160;</dd>
 968 <dt class="dr-param">y</dt>
 969 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 970 <dd class="dr-description">&#160;</dd>
 971 </dl>
 972 </div><div class="Matrix-x-section"><h3 id="Matrix.x" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.x(x, y)<a href="#Matrix.x" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2079 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2079">&#x27ad;</a></h3>
 973 <div class="extra" id="Matrix.x-extra"></div></div><div class="dr-method"><p>Return x coordinate for given point after transformation described by the matrix. See also <a href="#Matrix.y" class="dr-link">Matrix.y</a>
 974 </p>
 975 <p class="header">Parameters
 976 </p>
 977 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 978 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 979 <dd class="dr-description">&#160;</dd>
 980 <dt class="dr-param">y</dt>
 981 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 982 <dd class="dr-description">&#160;</dd>
 983 </dl>
 984 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">x</span></p>
 985 </div><div class="Matrix-y-section"><h3 id="Matrix.y" class="dr-method"><i class="dr-trixie">&#160;</i>Matrix.y(x, y)<a href="#Matrix.y" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2092 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2092">&#x27ad;</a></h3>
 986 <div class="extra" id="Matrix.y-extra"></div></div><div class="dr-method"><p>Return y coordinate for given point after transformation described by the matrix. See also <a href="#Matrix.x" class="dr-link">Matrix.x</a>
 987 </p>
 988 <p class="header">Parameters
 989 </p>
 990 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 991 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 992 <dd class="dr-description">&#160;</dd>
 993 <dt class="dr-param">y</dt>
 994 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 995 <dd class="dr-description">&#160;</dd>
 996 </dl>
 997 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">y</span></p>
 998 </div><div class="Paper-section"><h2 id="Paper" class="undefined"><i class="dr-trixie">&#160;</i>Paper<a href="#Paper" title="Link to this section" class="dr-hash">&#x2693;</a></h2>
 999 <div class="extra" id="Paper-extra"></div></div><div class="Paper-bottom-section"><h3 id="Paper.bottom" class="dr-property"><i class="dr-trixie">&#160;</i>Paper.bottom<a href="#Paper.bottom" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2978 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2978">&#x27ad;</a></h3>
1000 <div class="extra" id="Paper.bottom-extra"></div></div><div class="dr-property"><p>Points to the bottom element on the paper
1001 </p>
1002 </div><div class="Paper-ca-section"><h3 id="Paper.ca" class="dr-property"><i class="dr-trixie">&#160;</i>Paper.ca<a href="#Paper.ca" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 109 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L109">&#x27ad;</a></h3>
1003 <div class="extra" id="Paper.ca-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Shortcut for <a href="#Paper.customAttributes" class="dr-link">Paper.customAttributes</a>
1004 </p>
1005 </div><div class="Paper-circle-section"><h3 id="Paper.circle" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.circle(x, y, r)<a href="#Paper.circle" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2741 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2741">&#x27ad;</a></h3>
1006 <div class="extra" id="Paper.circle-extra"></div></div><div class="dr-method"><p>Draws a circle.
1007 </p>
1008 <p class="header">Parameters
1009 </p>
1010 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1011 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1012 <dd class="dr-description">x coordinate of the centre</dd>
1013 <dt class="dr-param">y</dt>
1014 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1015 <dd class="dr-description">y coordinate of the centre</dd>
1016 <dt class="dr-param">r</dt>
1017 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1018 <dd class="dr-description">radius</dd>
1019 </dl>
1020 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object with type “circle”</span></p>
1021 <p class="header">Usage
1022 </p>
1023 <pre class="javascript code"><code><b>var</b> c<span class="s"> = </span>paper.circle(<span class="d">50</span>, <span class="d">50</span>, <span class="d">40</span>);
1024 </code></pre>
1025 </div><div class="Paper-clear-section"><h3 id="Paper.clear" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.clear()<a href="#Paper.clear" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1309 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1309">&#x27ad;</a></h3>
1026 <div class="extra" id="Paper.clear-extra"></div></div><div class="dr-method"><p>Clears the paper, i.e. removes all the elements.
1027 </p>
1028 </div><div class="Paper-customAttributes-section"><h3 id="Paper.customAttributes" class="dr-property"><i class="dr-trixie">&#160;</i>Paper.customAttributes<a href="#Paper.customAttributes" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 135 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L135">&#x27ad;</a></h3>
1029 <div class="extra" id="Paper.customAttributes-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>If you have a set of attributes that you would like to represent
1030 as a function of some number you can do it easily with custom attributes:
1031 </p>
1032 <p class="header">Usage
1033 </p>
1034 <pre class="javascript code"><code>paper.customAttributes.hue<span class="s"> = </span><b>function</b> (num) {
1035     num<span class="s"> = </span>num<span class="s"> % </span><span class="d">1</span>;
1036     <b>return</b> {fill: <i>"hsb("</i><span class="s"> + </span>num<span class="s"> + </span><i>", <span class="d">0.75</span>, <span class="d">1</span>)"</i>};
1037 };
1038 <span class="c">// Custom attribute “hue” will change fill</span>
1039 <span class="c">// to be given hue <b>with</b> fixed saturation and brightness.</span>
1040 <span class="c">// Now you can use it like <b>this</b>:</span>
1041 <b>var</b> c<span class="s"> = </span>paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">10</span>).attr({hue: <span class="d">.45</span>});
1042 <span class="c">// or even like <b>this</b>:</span>
1043 c.animate({hue: <span class="d">1</span>}, <span class="d">1e3</span>);
1044
1045 <span class="c">// You could also create custom attribute</span>
1046 <span class="c">// <b>with</b> multiple parameters:</span>
1047 paper.customAttributes.hsb<span class="s"> = </span><b>function</b> (h, s, b) {
1048     <b>return</b> {fill: <i>"hsb("</i><span class="s"> + </span>[h, s, b].join(<i>","</i>)<span class="s"> + </span><i>")"</i>};
1049 };
1050 c.attr({hsb: <i>"<span class="d">0.5</span> <span class="d">.8</span> <span class="d">1</span>"</i>});
1051 c.animate({hsb: [<span class="d">1</span>, <span class="d">0</span>, <span class="d">0.5</span>]}, <span class="d">1e3</span>);
1052 </code></pre>
1053 </div><div class="Paper-ellipse-section"><h3 id="Paper.ellipse" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.ellipse(x, y, rx, ry)<a href="#Paper.ellipse" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2789 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2789">&#x27ad;</a></h3>
1054 <div class="extra" id="Paper.ellipse-extra"></div></div><div class="dr-method"><p>Draws an ellipse.
1055 </p>
1056 <p class="header">Parameters
1057 </p>
1058 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1059 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1060 <dd class="dr-description">x coordinate of the centre</dd>
1061 <dt class="dr-param">y</dt>
1062 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1063 <dd class="dr-description">y coordinate of the centre</dd>
1064 <dt class="dr-param">rx</dt>
1065 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1066 <dd class="dr-description">horizontal radius</dd>
1067 <dt class="dr-param">ry</dt>
1068 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1069 <dd class="dr-description">vertical radius</dd>
1070 </dl>
1071 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object with type “ellipse”</span></p>
1072 <p class="header">Usage
1073 </p>
1074 <pre class="javascript code"><code><b>var</b> c<span class="s"> = </span>paper.ellipse(<span class="d">50</span>, <span class="d">50</span>, <span class="d">40</span>, <span class="d">20</span>);
1075 </code></pre>
1076 </div><div class="Paper-forEach-section"><h3 id="Paper.forEach" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.forEach(callback, thisArg)<a href="#Paper.forEach" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3073 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3073">&#x27ad;</a></h3>
1077 <div class="extra" id="Paper.forEach-extra"></div></div><div class="dr-method"><p>Executes given function for each element on the paper
1078 </p>
1079 <p>If callback function returns <code>false</code> it will stop loop running.
1080 </p>
1081 <p class="header">Parameters
1082 </p>
1083 <dl class="dr-parameters"><dt class="dr-param">callback</dt>
1084 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1085 <dd class="dr-description">function to run</dd>
1086 <dt class="dr-param">thisArg</dt>
1087 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1088 <dd class="dr-description">context object for the callback</dd>
1089 </dl>
1090 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Paper object</span></p>
1091 </div><div class="Paper-getById-section"><h3 id="Paper.getById" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.getById(id)<a href="#Paper.getById" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3049 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3049">&#x27ad;</a></h3>
1092 <div class="extra" id="Paper.getById-extra"></div></div><div class="dr-method"><p>Returns you element by its internal ID.
1093 </p>
1094 <p class="header">Parameters
1095 </p>
1096 <dl class="dr-parameters"><dt class="dr-param">id</dt>
1097 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1098 <dd class="dr-description">id</dd>
1099 </dl>
1100 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object</span></p>
1101 </div><div class="Paper-getElementByPoint-section"><h3 id="Paper.getElementByPoint" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.getElementByPoint(x, y)<a href="#Paper.getElementByPoint" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3013 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3013">&#x27ad;</a></h3>
1102 <div class="extra" id="Paper.getElementByPoint-extra"></div></div><div class="dr-method"><p>Returns you topmost element under given point.
1103 </p>
1104 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object</span></p>
1105 <p class="header">Parameters
1106 </p>
1107 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1108 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1109 <dd class="dr-description">x coordinate from the top left corner of the window</dd>
1110 <dt class="dr-param">y</dt>
1111 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1112 <dd class="dr-description">y coordinate from the top left corner of the window</dd>
1113 </dl>
1114 <p class="header">Usage
1115 </p>
1116 <pre class="javascript code"><code>paper.getElementByPoint(mouseX, mouseY).attr({stroke: <i>"#f00"</i>});
1117 </code></pre>
1118 </div><div class="Paper-getFont-section"><h3 id="Paper.getFont" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.getFont(family, [weight], [style], [stretch])<a href="#Paper.getFont" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4431 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4431">&#x27ad;</a></h3>
1119 <div class="extra" id="Paper.getFont-extra"></div></div><div class="dr-method"><p>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”.
1120 </p>
1121 <p class="header">Parameters
1122 </p>
1123 <dl class="dr-parameters"><dt class="dr-param">family</dt>
1124 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1125 <dd class="dr-description">font family name or any word from it</dd>
1126 <dt class="dr-param optional">weight</dt>
1127 <dd class="dr-optional">optional</dd>
1128 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1129 <dd class="dr-description">font weight</dd>
1130 <dt class="dr-param optional">style</dt>
1131 <dd class="dr-optional">optional</dd>
1132 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1133 <dd class="dr-description">font style</dd>
1134 <dt class="dr-param optional">stretch</dt>
1135 <dd class="dr-optional">optional</dd>
1136 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1137 <dd class="dr-description">font stretch</dd>
1138 </dl>
1139 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">the font object</span></p>
1140 <p class="header">Usage
1141 </p>
1142 <pre class="javascript code"><code>paper.print(<span class="d">100</span>, <span class="d">100</span>, <i>"Test string"</i>, paper.getFont(<i>"Times"</i>, <span class="d">800</span>), <span class="d">30</span>);
1143 </code></pre>
1144 </div><div class="Paper-image-section"><h3 id="Paper.image" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.image(src, x, y, width, height)<a href="#Paper.image" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2848 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2848">&#x27ad;</a></h3>
1145 <div class="extra" id="Paper.image-extra"></div></div><div class="dr-method"><p>Embeds an image into the surface.
1146 </p>
1147 <p class="header">Parameters
1148 </p>
1149 <dl class="dr-parameters"><dt class="dr-param">src</dt>
1150 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1151 <dd class="dr-description">URI of the source image</dd>
1152 <dt class="dr-param">x</dt>
1153 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1154 <dd class="dr-description">x coordinate position</dd>
1155 <dt class="dr-param">y</dt>
1156 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1157 <dd class="dr-description">y coordinate position</dd>
1158 <dt class="dr-param">width</dt>
1159 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1160 <dd class="dr-description">width of the image</dd>
1161 <dt class="dr-param">height</dt>
1162 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1163 <dd class="dr-description">height of the image</dd>
1164 </dl>
1165 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object with type “image”</span></p>
1166 <p class="header">Usage
1167 </p>
1168 <pre class="javascript code"><code><b>var</b> c<span class="s"> = </span>paper.image(<i>"apple.png"</i>, <span class="d">10</span>, <span class="d">10</span>, <span class="d">80</span>, <span class="d">80</span>);
1169 </code></pre>
1170 </div><div class="Paper-path-section"><h3 id="Paper.path" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.path([pathString])<a href="#Paper.path" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2824 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2824">&#x27ad;</a></h3>
1171 <div class="extra" id="Paper.path-extra"></div></div><div class="dr-method"><p>Creates a path element by given path data string.
1172 </p>
1173 <p class="header">Parameters
1174 </p>
1175 <dl class="dr-parameters"><dt class="dr-param optional">pathString</dt>
1176 <dd class="dr-optional">optional</dd>
1177 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1178 <dd class="dr-description">path string in SVG format.</dd>
1179 </dl>
1180 <p>Path string consists of one-letter commands, followed by comma seprarated arguments in numercal form. Example:
1181 </p>
1182 <pre class="javascript code"><code><i>"M10,20L30,<span class="d">40</span>"</i>
1183 </code></pre>
1184 <p>Here we can see two commands: “M”, with arguments <code>(10, 20)</code> and “L” with arguments <code>(30, 40)</code>. Upper case letter mean command is absolute, lower case—relative.
1185 </p>
1186 <p></p>
1187 <p>Here is short list of commands available, for more details see <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>.</p>
1188 <table><thead><tr><th>Command</th><th>Name</th><th>Parameters</th></tr></thead><tbody>
1189 <tr><td>M</td><td>moveto</td><td>(x y)+</td></tr>
1190 <tr><td>Z</td><td>closepath</td><td>(none)</td></tr>
1191 <tr><td>L</td><td>lineto</td><td>(x y)+</td></tr>
1192 <tr><td>H</td><td>horizontal lineto</td><td>x+</td></tr>
1193 <tr><td>V</td><td>vertical lineto</td><td>y+</td></tr>
1194 <tr><td>C</td><td>curveto</td><td>(x1 y1 x2 y2 x y)+</td></tr>
1195 <tr><td>S</td><td>smooth curveto</td><td>(x2 y2 x y)+</td></tr>
1196 <tr><td>Q</td><td>quadratic Bézier curveto</td><td>(x1 y1 x y)+</td></tr>
1197 <tr><td>T</td><td>smooth quadratic Bézier curveto</td><td>(x y)+</td></tr>
1198 <tr><td>A</td><td>elliptical arc</td><td>(rx ry x-axis-rotation large-arc-flag sweep-flag x y)+</td></tr>
1199 <tr><td>R</td><td><a href="http://en.wikipedia.org/wiki/Catmull–Rom_spline#Catmull.E2.80.93Rom_spline">Catmull-Rom curveto</a>*</td><td>x1 y1 (x y)+</td></tr></tbody></table>
1200 <p>* “Catmull-Rom curveto” is a not standard SVG command and added in 2.0 to make life easier.
1201 </p>
1202 <p class="header">Usage
1203 </p>
1204 <pre class="javascript code"><code><b>var</b> c<span class="s"> = </span>paper.path(<i>"M10 10L90 <span class="d">90</span>"</i>);
1205 <span class="c">// draw a diagonal line:</span>
1206 <span class="c">// move to <span class="d">10</span>,<span class="d">10</span>, line to <span class="d">90</span>,<span class="d">90</span></span>
1207 </code></pre>
1208 </div><div class="Paper-print-section"><h3 id="Paper.print" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.print(x, y, text, font, [size], [origin], [letter_spacing])<a href="#Paper.print" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4481 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4481">&#x27ad;</a></h3>
1209 <div class="extra" id="Paper.print-extra"></div></div><div class="dr-method"><p>Creates set of shapes to represent given font at given position with given size.
1210 Result of the method is set object (see <a href="#Paper.set" class="dr-link">Paper.set</a>) which contains each letter as separate path object.
1211 </p>
1212 <p class="header">Parameters
1213 </p>
1214 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1215 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1216 <dd class="dr-description">x position of the text</dd>
1217 <dt class="dr-param">y</dt>
1218 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1219 <dd class="dr-description">y position of the text</dd>
1220 <dt class="dr-param">text</dt>
1221 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1222 <dd class="dr-description">text to print</dd>
1223 <dt class="dr-param">font</dt>
1224 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1225 <dd class="dr-description">font object, see <a href="#Paper.getFont" class="dr-link">Paper.getFont</a></dd>
1226 <dt class="dr-param optional">size</dt>
1227 <dd class="dr-optional">optional</dd>
1228 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1229 <dd class="dr-description">size of the font, default is <code>16</code></dd>
1230 <dt class="dr-param optional">origin</dt>
1231 <dd class="dr-optional">optional</dd>
1232 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1233 <dd class="dr-description">could be <code>"baseline"</code> or <code>"middle"</code>, default is <code>"middle"</code></dd>
1234 <dt class="dr-param optional">letter_spacing</dt>
1235 <dd class="dr-optional">optional</dd>
1236 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1237 <dd class="dr-description">number in range <code>-1..1</code>, default is <code>0</code></dd>
1238 </dl>
1239 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">resulting set of letters</span></p>
1240 <p class="header">Usage
1241 </p>
1242 <pre class="javascript code"><code><b>var</b> txt<span class="s"> = </span>r.print(<span class="d">10</span>, <span class="d">50</span>, <i>"print"</i>, r.getFont(<i>"Museo"</i>), <span class="d">30</span>).attr({fill: <i>"#fff"</i>});
1243 <span class="c">// following line will paint first letter <b>in</b> red</span>
1244 txt[<span class="d">0</span>].attr({fill: <i>"#f00"</i>});
1245 </code></pre>
1246 </div><div class="Paper-raphael-section"><h3 id="Paper.raphael" class="dr-property"><i class="dr-trixie">&#160;</i>Paper.raphael<a href="#Paper.raphael" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2985 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2985">&#x27ad;</a></h3>
1247 <div class="extra" id="Paper.raphael-extra"></div></div><div class="dr-property"><p>Points to the <a href="#Raphael" class="dr-link">Raphael</a> object/function
1248 </p>
1249 </div><div class="Paper-rect-section"><h3 id="Paper.rect" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.rect(x, y, width, height, [r])<a href="#Paper.rect" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2767 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2767">&#x27ad;</a></h3>
1250 <div class="extra" id="Paper.rect-extra"></div></div><div class="dr-method"><p></p>
1251 <p>Draws a rectangle.
1252 </p>
1253 <p class="header">Parameters
1254 </p>
1255 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1256 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1257 <dd class="dr-description">x coordinate of the top left corner</dd>
1258 <dt class="dr-param">y</dt>
1259 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1260 <dd class="dr-description">y coordinate of the top left corner</dd>
1261 <dt class="dr-param">width</dt>
1262 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1263 <dd class="dr-description">width</dd>
1264 <dt class="dr-param">height</dt>
1265 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1266 <dd class="dr-description">height</dd>
1267 <dt class="dr-param optional">r</dt>
1268 <dd class="dr-optional">optional</dd>
1269 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1270 <dd class="dr-description">radius for rounded corners, default is 0</dd>
1271 </dl>
1272 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object with type “rect”</span></p>
1273 <p class="header">Usage
1274 </p>
1275 <pre class="javascript code"><code><span class="c">// regular rectangle</span>
1276 <b>var</b> c<span class="s"> = </span>paper.rect(<span class="d">10</span>, <span class="d">10</span>, <span class="d">50</span>, <span class="d">50</span>);
1277 <span class="c">// rectangle <b>with</b> rounded corners</span>
1278 <b>var</b> c<span class="s"> = </span>paper.rect(<span class="d">40</span>, <span class="d">40</span>, <span class="d">50</span>, <span class="d">50</span>, <span class="d">10</span>);
1279 </code></pre>
1280 </div><div class="Paper-remove-section"><h3 id="Paper.remove" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.remove()<a href="#Paper.remove" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1326 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1326">&#x27ad;</a></h3>
1281 <div class="extra" id="Paper.remove-extra"></div></div><div class="dr-method"><p>Removes the paper from the DOM.
1282 </p>
1283 </div><div class="Paper-renderfix-section"><h3 id="Paper.renderfix" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.renderfix()<a href="#Paper.renderfix" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1286 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.svg.js#L1286">&#x27ad;</a></h3>
1284 <div class="extra" id="Paper.renderfix-extra"></div></div><div class="dr-method"><p>Fixes the issue of Firefox and IE9 regarding subpixel rendering. If paper is dependant
1285 on other elements after reflow it could shift half pixel which cause for lines to lost their crispness.
1286 This method fixes the issue.
1287 </p>
1288 </div><div class="Paper-safari-section"><h3 id="Paper.safari" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.safari()<a href="#Paper.safari" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2197 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2197">&#x27ad;</a></h3>
1289 <div class="extra" id="Paper.safari-extra"></div></div><div class="dr-method"><p>There is an inconvenient rendering bug in Safari (WebKit):
1290 sometimes the rendering should be forced.
1291 This method should help with dealing with this bug.
1292 </p>
1293 </div><div class="Paper-set-section"><h3 id="Paper.set" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.set()<a href="#Paper.set" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2891 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2891">&#x27ad;</a></h3>
1294 <div class="extra" id="Paper.set-extra"></div></div><div class="dr-method"><p>Creates array-like object to keep and operate several elements at once.
1295 Warning: it doesn’t create any elements for itself in the page, it just groups existing elements.
1296 Sets act as pseudo elements — all methods available to an element can be used on a set.
1297 </p>
1298 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">array-like object that represents set of elements</span></p>
1299 <p class="header">Usage
1300 </p>
1301 <pre class="javascript code"><code><b>var</b> st<span class="s"> = </span>paper.set();
1302 st.push(
1303     paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">5</span>),
1304     paper.circle(<span class="d">30</span>, <span class="d">10</span>, <span class="d">5</span>)
1305 );
1306 st.attr({fill: <i>"red"</i>}); <span class="c">// changes the fill of both circles</span>
1307 </code></pre>
1308 </div><div class="Paper-setFinish-section"><h3 id="Paper.setFinish" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.setFinish()<a href="#Paper.setFinish" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2922 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2922">&#x27ad;</a></h3>
1309 <div class="extra" id="Paper.setFinish-extra"></div></div><div class="dr-method"><p>See <a href="#Paper.setStart" class="dr-link">Paper.setStart</a>. This method finishes catching and returns resulting set.
1310 </p>
1311 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">set</span></p>
1312 </div><div class="Paper-setSize-section"><h3 id="Paper.setSize" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.setSize(width, height)<a href="#Paper.setSize" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2945 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2945">&#x27ad;</a></h3>
1313 <div class="extra" id="Paper.setSize-extra"></div></div><div class="dr-method"><p>If you need to change dimensions of the canvas call this method
1314 </p>
1315 <p class="header">Parameters
1316 </p>
1317 <dl class="dr-parameters"><dt class="dr-param">width</dt>
1318 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1319 <dd class="dr-description">new width of the canvas</dd>
1320 <dt class="dr-param">height</dt>
1321 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1322 <dd class="dr-description">new height of the canvas</dd>
1323 </dl>
1324 <p class="header">Usage
1325 </p>
1326 <pre class="javascript code"><code><b>var</b> st<span class="s"> = </span>paper.set();
1327 st.push(
1328     paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">5</span>),
1329     paper.circle(<span class="d">30</span>, <span class="d">10</span>, <span class="d">5</span>)
1330 );
1331 st.attr({fill: <i>"red"</i>});
1332 </code></pre>
1333 </div><div class="Paper-setStart-section"><h3 id="Paper.setStart" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.setStart()<a href="#Paper.setStart" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2911 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2911">&#x27ad;</a></h3>
1334 <div class="extra" id="Paper.setStart-extra"></div></div><div class="dr-method"><p>Creates <a href="#Paper.set" class="dr-link">Paper.set</a>. All elements that will be created after calling this method and before calling
1335 <a href="#Paper.setFinish" class="dr-link">Paper.setFinish</a> will be added to the set.
1336 </p>
1337 <p class="header">Usage
1338 </p>
1339 <pre class="javascript code"><code>paper.setStart();
1340 paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">5</span>),
1341 paper.circle(<span class="d">30</span>, <span class="d">10</span>, <span class="d">5</span>)
1342 <b>var</b> st<span class="s"> = </span>paper.setFinish();
1343 st.attr({fill: <i>"red"</i>}); <span class="c">// changes the fill of both circles</span>
1344 </code></pre>
1345 </div><div class="Paper-setViewBox-section"><h3 id="Paper.setViewBox" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.setViewBox(x, y, w, h, fit)<a href="#Paper.setViewBox" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2963 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2963">&#x27ad;</a></h3>
1346 <div class="extra" id="Paper.setViewBox-extra"></div></div><div class="dr-method"><p>Sets the view box of the paper. Practically it gives you ability to zoom and pan whole paper surface by
1347 specifying new boundaries.
1348 </p>
1349 <p class="header">Parameters
1350 </p>
1351 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1352 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1353 <dd class="dr-description">new x position, default is <code>0</code></dd>
1354 <dt class="dr-param">y</dt>
1355 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1356 <dd class="dr-description">new y position, default is <code>0</code></dd>
1357 <dt class="dr-param">w</dt>
1358 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1359 <dd class="dr-description">new width of the canvas</dd>
1360 <dt class="dr-param">h</dt>
1361 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1362 <dd class="dr-description">new height of the canvas</dd>
1363 <dt class="dr-param">fit</dt>
1364 <dd class="dr-type"><em class="dr-type-boolean">boolean</em></dd>
1365 <dd class="dr-description"><code>true</code> if you want graphics to fit into new boundary box</dd>
1366 </dl>
1367 </div><div class="Paper-text-section"><h3 id="Paper.text" class="dr-method"><i class="dr-trixie">&#160;</i>Paper.text(x, y, text)<a href="#Paper.text" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2869 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2869">&#x27ad;</a></h3>
1368 <div class="extra" id="Paper.text-extra"></div></div><div class="dr-method"><p>Draws a text string. If you need line breaks, put “\n” in the string.
1369 </p>
1370 <p class="header">Parameters
1371 </p>
1372 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1373 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1374 <dd class="dr-description">x coordinate position</dd>
1375 <dt class="dr-param">y</dt>
1376 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1377 <dd class="dr-description">y coordinate position</dd>
1378 <dt class="dr-param">text</dt>
1379 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1380 <dd class="dr-description">The text string to draw</dd>
1381 </dl>
1382 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphaël element object with type “text”</span></p>
1383 <p class="header">Usage
1384 </p>
1385 <pre class="javascript code"><code><b>var</b> t<span class="s"> = </span>paper.text(<span class="d">50</span>, <span class="d">50</span>, <i>"Raphaël\nkicks\nbutt!"</i>);
1386 </code></pre>
1387 </div><div class="Paper-top-section"><h3 id="Paper.top" class="dr-property"><i class="dr-trixie">&#160;</i>Paper.top<a href="#Paper.top" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2972 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2972">&#x27ad;</a></h3>
1388 <div class="extra" id="Paper.top-extra"></div></div><div class="dr-property"><p>Points to the topmost element on the paper
1389 </p>
1390 </div><div class="Raphael-section"><h2 id="Raphael" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael(…)<a href="#Raphael" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 59 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L59">&#x27ad;</a></h2>
1391 <div class="extra" id="Raphael-extra"></div></div><div class="dr-method"><p>Creates a canvas object on which to draw.
1392 You must do this first, as all future calls to drawing methods
1393 from this instance will be bound to this canvas.
1394 </p>
1395 <p class="header">Parameters
1396 </p>
1397 <dl class="dr-parameters"><dt class="dr-param">container</dt>
1398 <dd class="dr-type"><em class="dr-type-HTMLElement">HTMLElement</em> <em class="dr-type-string">string</em></dd>
1399 <dd class="dr-description">DOM element or its ID which is going to be a parent for drawing surface</dd>
1400 <dt class="dr-param">width</dt>
1401 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1402 <dd class="dr-description">&#160;</dd>
1403 <dt class="dr-param">height</dt>
1404 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1405 <dd class="dr-description">&#160;</dd>
1406 <dt class="dr-param optional">callback</dt>
1407 <dd class="dr-optional">optional</dd>
1408 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1409 <dd class="dr-description">callback function which is going to be executed in the context of newly created paper</dd>
1410 </dl>
1411 <p>or
1412 </p>
1413 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1414 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1415 <dd class="dr-description">&#160;</dd>
1416 <dt class="dr-param">y</dt>
1417 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1418 <dd class="dr-description">&#160;</dd>
1419 <dt class="dr-param">width</dt>
1420 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1421 <dd class="dr-description">&#160;</dd>
1422 <dt class="dr-param">height</dt>
1423 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1424 <dd class="dr-description">&#160;</dd>
1425 <dt class="dr-param optional">callback</dt>
1426 <dd class="dr-optional">optional</dd>
1427 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1428 <dd class="dr-description">callback function which is going to be executed in the context of newly created paper</dd>
1429 </dl>
1430 <p>or
1431 </p>
1432 <dl class="dr-parameters"><dt class="dr-param">all</dt>
1433 <dd class="dr-type"><em class="dr-type-array">array</em></dd>
1434 <dd class="dr-description">(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>})</dd>
1435 <dt class="dr-param optional">callback</dt>
1436 <dd class="dr-optional">optional</dd>
1437 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1438 <dd class="dr-description">callback function which is going to be executed in the context of newly created paper</dd>
1439 </dl>
1440 <p>or
1441 </p>
1442 <dl class="dr-parameters"><dt class="dr-param">onReadyCallback</dt>
1443 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1444 <dd class="dr-description">function that is going to be called on DOM ready event. You can also subscribe to this event via Eve’s “DOMLoad” event. In this case method returns <code>undefined</code>.</dd>
1445 </dl>
1446 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Paper" class="dr-link">Paper</a></span></p>
1447 <p class="header">Usage
1448 </p>
1449 <pre class="javascript code"><code><span class="c">// Each of the following examples create a canvas</span>
1450 <span class="c">// that is 320px wide by 200px high.</span>
1451 <span class="c">// Canvas is created at the viewport’s <span class="d">10</span>,<span class="d">50</span> coordinate.</span>
1452 <b>var</b> paper<span class="s"> = </span>Raphael(<span class="d">10</span>, <span class="d">50</span>, <span class="d">320</span>, <span class="d">200</span>);
1453 <span class="c">// Canvas is created at the top left corner of the #notepad element</span>
1454 <span class="c">// (or its top right corner <b>in</b> dir=<i>"rtl"</i> elements)</span>
1455 <b>var</b> paper<span class="s"> = </span>Raphael(document.getElementById(<i>"notepad"</i>), <span class="d">320</span>, <span class="d">200</span>);
1456 <span class="c">// Same as above</span>
1457 <b>var</b> paper<span class="s"> = </span>Raphael(<i>"notepad"</i>, <span class="d">320</span>, <span class="d">200</span>);
1458 <span class="c">// Image dump</span>
1459 <b>var</b> set<span class="s"> = </span>Raphael([<i>"notepad"</i>, <span class="d">320</span>, <span class="d">200</span>, {
1460     type: <i>"rect"</i>,
1461     x: <span class="d">10</span>,
1462     y: <span class="d">10</span>,
1463     width: <span class="d">25</span>,
1464     height: <span class="d">25</span>,
1465     stroke: <i>"#f00"</i>
1466 }, {
1467     type: <i>"text"</i>,
1468     x: <span class="d">30</span>,
1469     y: <span class="d">40</span>,
1470     text: <i>"Dump"</i>
1471 }]);
1472 </code></pre>
1473 </div><div class="Raphael-angle-section"><h3 id="Raphael.angle" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.angle(x1, y1, x2, y2, [x3], [y3])<a href="#Raphael.angle" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 409 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L409">&#x27ad;</a></h3>
1474 <div class="extra" id="Raphael.angle-extra"></div></div><div class="dr-method"><p>Returns angle between two or three points
1475 </p>
1476 <p class="header">Parameters
1477 </p>
1478 <dl class="dr-parameters"><dt class="dr-param">x1</dt>
1479 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1480 <dd class="dr-description">x coord of first point</dd>
1481 <dt class="dr-param">y1</dt>
1482 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1483 <dd class="dr-description">y coord of first point</dd>
1484 <dt class="dr-param">x2</dt>
1485 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1486 <dd class="dr-description">x coord of second point</dd>
1487 <dt class="dr-param">y2</dt>
1488 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1489 <dd class="dr-description">y coord of second point</dd>
1490 <dt class="dr-param optional">x3</dt>
1491 <dd class="dr-optional">optional</dd>
1492 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1493 <dd class="dr-description">x coord of third point</dd>
1494 <dt class="dr-param optional">y3</dt>
1495 <dd class="dr-optional">optional</dd>
1496 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1497 <dd class="dr-description">y coord of third point</dd>
1498 </dl>
1499 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">angle in degrees.</span></p>
1500 </div><div class="Raphael-animation-section"><h3 id="Raphael.animation" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.animation(params, ms, [easing], [callback])<a href="#Raphael.animation" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3955 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3955">&#x27ad;</a></h3>
1501 <div class="extra" id="Raphael.animation-extra"></div></div><div class="dr-method"><p>Creates an animation object that can be passed to the <a href="#Element.animate" class="dr-link">Element.animate</a> or <a href="#Element.animateWith" class="dr-link">Element.animateWith</a> methods.
1502 See also <a href="#Animation.delay" class="dr-link">Animation.delay</a> and <a href="#Animation.repeat" class="dr-link">Animation.repeat</a> methods.
1503 </p>
1504 <p class="header">Parameters
1505 </p>
1506 <dl class="dr-parameters"><dt class="dr-param">params</dt>
1507 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1508 <dd class="dr-description">final attributes for the element, see also <a href="#Element.attr" class="dr-link">Element.attr</a></dd>
1509 <dt class="dr-param">ms</dt>
1510 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1511 <dd class="dr-description">number of milliseconds for animation to run</dd>
1512 <dt class="dr-param optional">easing</dt>
1513 <dd class="dr-optional">optional</dd>
1514 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1515 <dd class="dr-description">easing type. Accept one of <a href="#Raphael.easing_formulas" class="dr-link">Raphael.easing_formulas</a> or CSS format: <code>cubic&#x2010;bezier(XX,&#160;XX,&#160;XX,&#160;XX)</code></dd>
1516 <dt class="dr-param optional">callback</dt>
1517 <dd class="dr-optional">optional</dd>
1518 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1519 <dd class="dr-description">callback function. Will be called at the end of animation.</dd>
1520 </dl>
1521 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Animation" class="dr-link">Animation</a></span></p>
1522 </div><div class="Raphael-color-section"><h3 id="Raphael.color" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.color(clr)<a href="#Raphael.color" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 608 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L608">&#x27ad;</a></h3>
1523 <div class="extra" id="Raphael.color-extra"></div></div><div class="dr-method"><p>Parses the color string and returns object with all values for the given color.
1524 </p>
1525 <p class="header">Parameters
1526 </p>
1527 <dl class="dr-parameters"><dt class="dr-param">clr</dt>
1528 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1529 <dd class="dr-description">color string in one of the supported formats (see <a href="#Raphael.getRGB" class="dr-link">Raphael.getRGB</a>)</dd>
1530 </dl>
1531 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Combined RGB <em class="amp">&amp;</em> HSB object in format:</span></p>
1532 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">r</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">red,</span>
1533 <li><span class="dr-json-key">g</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">green,</span>
1534 <li><span class="dr-json-key">b</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">blue,</span>
1535 <li><span class="dr-json-key">hex</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">color in HTML/CSS format: #••••••,</span>
1536 <li><span class="dr-json-key">error</span><span class="dr-type"><em class="dr-type-boolean">boolean</em></span><span class="dr-json-description"><code>true</code> if string can’t be parsed,</span>
1537 <li><span class="dr-json-key">h</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">hue,</span>
1538 <li><span class="dr-json-key">s</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">saturation,</span>
1539 <li><span class="dr-json-key">v</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">value (brightness),</span>
1540 <li><span class="dr-json-key">l</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">lightness</span>
1541 </ol></li><li>}</li></ol>
1542 </div><div class="Raphael-createUUID-section"><h3 id="Raphael.createUUID" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.createUUID()<a href="#Raphael.createUUID" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 482 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L482">&#x27ad;</a></h3>
1543 <div class="extra" id="Raphael.createUUID-extra"></div></div><div class="dr-method"><p>Returns RFC4122, version 4 ID
1544 </p>
1545 </div><div class="Raphael-deg-section"><h3 id="Raphael.deg" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.deg(deg)<a href="#Raphael.deg" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 442 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L442">&#x27ad;</a></h3>
1546 <div class="extra" id="Raphael.deg-extra"></div></div><div class="dr-method"><p>Transform angle to degrees
1547 </p>
1548 <p class="header">Parameters
1549 </p>
1550 <dl class="dr-parameters"><dt class="dr-param">deg</dt>
1551 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1552 <dd class="dr-description">angle in radians</dd>
1553 </dl>
1554 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">angle in degrees.</span></p>
1555 </div><div class="Raphael-easing_formulas-section"><h3 id="Raphael.easing_formulas" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.easing_formulas<a href="#Raphael.easing_formulas" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3396 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3396">&#x27ad;</a></h3>
1556 <div class="extra" id="Raphael.easing_formulas-extra"></div></div><div class="dr-property"><p>Object that contains easing formulas for animation. You could extend it with your own. By default it has following list of easing:
1557 </p>
1558 <ul>
1559     <li>“linear”</li>
1560     <li>“&lt;” or “easeIn” or “ease-in”</li>
1561     <li>“>” or “easeOut” or “ease-out”</li>
1562     <li>“&lt;>” or “easeInOut” or “ease-in-out”</li>
1563     <li>“backIn” or “back-in”</li>
1564     <li>“backOut” or “back-out”</li>
1565     <li>“elastic”</li>
1566     <li>“bounce”</li>
1567 </ul>
1568 <p>See also <a href="http://raphaeljs.com/easing.html">Easing demo</a>.</p>
1569 </div><div class="Raphael-el-section"><h3 id="Raphael.el" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.el<a href="#Raphael.el" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 2333 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L2333">&#x27ad;</a></h3>
1570 <div class="extra" id="Raphael.el-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>You can add your own method to elements. This is usefull when you want to hack default functionality or
1571 want to wrap some common transformation or attributes in one method. In difference to canvas methods,
1572 you can redefine element method at any time. Expending element methods wouldn’t affect set.
1573 </p>
1574 <p class="header">Usage
1575 </p>
1576 <pre class="javascript code"><code>Raphael.el.red<span class="s"> = </span><b>function</b> () {
1577     <b>this</b>.attr({fill: <i>"#f00"</i>});
1578 };
1579 <span class="c">// then use it</span>
1580 paper.circle(<span class="d">100</span>, <span class="d">100</span>, <span class="d">20</span>).red();
1581 </code></pre>
1582 </div><div class="Raphael-findDotsAtSegment-section"><h3 id="Raphael.findDotsAtSegment" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.findDotsAtSegment(p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t)<a href="#Raphael.findDotsAtSegment" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1149 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1149">&#x27ad;</a></h3>
1583 <div class="extra" id="Raphael.findDotsAtSegment-extra"></div></div><div class="dr-method"><p>Utility method
1584 Find dot coordinates on the given cubic bezier curve at the given t.
1585 </p>
1586 <p class="header">Parameters
1587 </p>
1588 <dl class="dr-parameters"><dt class="dr-param">p1x</dt>
1589 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1590 <dd class="dr-description">x of the first point of the curve</dd>
1591 <dt class="dr-param">p1y</dt>
1592 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1593 <dd class="dr-description">y of the first point of the curve</dd>
1594 <dt class="dr-param">c1x</dt>
1595 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1596 <dd class="dr-description">x of the first anchor of the curve</dd>
1597 <dt class="dr-param">c1y</dt>
1598 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1599 <dd class="dr-description">y of the first anchor of the curve</dd>
1600 <dt class="dr-param">c2x</dt>
1601 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1602 <dd class="dr-description">x of the second anchor of the curve</dd>
1603 <dt class="dr-param">c2y</dt>
1604 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1605 <dd class="dr-description">y of the second anchor of the curve</dd>
1606 <dt class="dr-param">p2x</dt>
1607 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1608 <dd class="dr-description">x of the second point of the curve</dd>
1609 <dt class="dr-param">p2y</dt>
1610 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1611 <dd class="dr-description">y of the second point of the curve</dd>
1612 <dt class="dr-param">t</dt>
1613 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1614 <dd class="dr-description">position on the curve (0..1)</dd>
1615 </dl>
1616 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">point information in format:</span></p>
1617 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate of the point</span>
1618 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate of the point</span>
1619 <li>    m: {<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate of the left anchor</span>
1620 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate of the left anchor</span>
1621 </ol></li><li>    }</li><li>    n: {<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate of the right anchor</span>
1622 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate of the right anchor</span>
1623 </ol></li><li>    }</li><li>    start: {<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate of the start of the curve</span>
1624 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate of the start of the curve</span>
1625 </ol></li><li>    }</li><li>    end: {<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate of the end of the curve</span>
1626 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate of the end of the curve</span>
1627 </ol></li><li>    }</li><li><span class="dr-json-key">alpha:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">angle of the curve derivative at the point</span>
1628 </ol></li><li>}</li></ol>
1629 </div><div class="Raphael-fn-section"><h3 id="Raphael.fn" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.fn<a href="#Raphael.fn" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 368 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L368">&#x27ad;</a></h3>
1630 <div class="extra" id="Raphael.fn-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>You can add your own method to the canvas. For example if you want to draw a pie chart,
1631 you can create your own pie chart function and ship it as a Raphaël plugin. To do this
1632 you need to extend the <code>Raphael.fn</code> object. Please note that you can create your own namespaces
1633 inside the <code>fn</code> object — methods will be run in the context of canvas anyway. You should alter
1634 the <code>fn</code> object before a Raphaël instance is created, otherwise it will take no effect.
1635 </p>
1636 <p class="header">Usage
1637 </p>
1638 <pre class="javascript code"><code>Raphael.fn.arrow<span class="s"> = </span><b>function</b> (x1, y1, x2, y2, size) {
1639     <b>return</b> <b>this</b>.path( ... );
1640 };
1641 <span class="c">// or create namespace</span>
1642 Raphael.fn.mystuff<span class="s"> = </span>{
1643     arrow: <b>function</b> () {…},
1644     star: <b>function</b> () {…},
1645     <span class="c">// etc…</span>
1646 };
1647 <b>var</b> paper<span class="s"> = </span>Raphael(<span class="d">10</span>, <span class="d">10</span>, <span class="d">630</span>, <span class="d">480</span>);
1648 <span class="c">// then use it</span>
1649 paper.arrow(<span class="d">10</span>, <span class="d">10</span>, <span class="d">30</span>, <span class="d">30</span>, <span class="d">5</span>).attr({fill: <i>"#f00"</i>});
1650 paper.mystuff.arrow();
1651 paper.mystuff.star();
1652 </code></pre>
1653 </div><div class="Raphael-format-section"><h3 id="Raphael.format" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.format(token, …)<a href="#Raphael.format" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4529 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4529">&#x27ad;</a></h3>
1654 <div class="extra" id="Raphael.format-extra"></div></div><div class="dr-method"><p>Simple format function. Replaces construction of type “<code>{&lt;number>}</code>” to the corresponding argument.
1655 </p>
1656 <p class="header">Parameters
1657 </p>
1658 <dl class="dr-parameters"><dt class="dr-param">token</dt>
1659 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1660 <dd class="dr-description">string to format</dd>
1661 <dt class="dr-param">…</dt>
1662 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1663 <dd class="dr-description">rest of arguments will be treated as parameters for replacement</dd>
1664 </dl>
1665 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">formated string</span></p>
1666 <p class="header">Usage
1667 </p>
1668 <pre class="javascript code"><code><b>var</b> x<span class="s"> = </span><span class="d">10</span>,
1669     y<span class="s"> = </span><span class="d">20</span>,
1670     width<span class="s"> = </span><span class="d">40</span>,
1671     height<span class="s"> = </span><span class="d">50</span>;
1672 <span class="c">// <b>this</b> will draw a rectangular shape equivalent to <i>"M10,20h40v50h-40z"</i></span>
1673 paper.path(Raphael.format(<i>"M{<span class="d">1</span>},{<span class="d">2</span>}h{<span class="d">3</span>}v{<span class="d">4</span>}h{<span class="d">5</span>}z"</i>, x, y, width, height, -width));
1674 </code></pre>
1675 </div><div class="Raphael-fullfill-section"><h3 id="Raphael.fullfill" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.fullfill(token, json)<a href="#Raphael.fullfill" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4559 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4559">&#x27ad;</a></h3>
1676 <div class="extra" id="Raphael.fullfill-extra"></div></div><div class="dr-method"><p>A little bit more advanced format function than <a href="#Raphael.format" class="dr-link">Raphael.format</a>. Replaces construction of type “<code>{&lt;name>}</code>” to the corresponding argument.
1677 </p>
1678 <p class="header">Parameters
1679 </p>
1680 <dl class="dr-parameters"><dt class="dr-param">token</dt>
1681 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1682 <dd class="dr-description">string to format</dd>
1683 <dt class="dr-param">json</dt>
1684 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1685 <dd class="dr-description">object which properties will be used as a replacement</dd>
1686 </dl>
1687 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">formated string</span></p>
1688 <p class="header">Usage
1689 </p>
1690 <pre class="javascript code"><code><span class="c">// <b>this</b> will draw a rectangular shape equivalent to <i>"M10,20h40v50h-40z"</i></span>
1691 paper.path(Raphael.format(<i>"M{x},{y}h{dim.width}v{dim.height}h{dim['negative width']}z"</i>, {
1692     x: <span class="d">10</span>,
1693     y: <span class="d">20</span>,
1694     dim: {
1695         width: <span class="d">40</span>,
1696         height: <span class="d">50</span>,
1697         <i>"negative width"</i>: -<span class="d">40</span>
1698     }
1699 }));
1700 </code></pre>
1701 </div><div class="Raphael-getColor-section"><h3 id="Raphael.getColor" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.getColor([value])<a href="#Raphael.getColor" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 984 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L984">&#x27ad;</a></h3>
1702 <div class="extra" id="Raphael.getColor-extra"></div></div><div class="dr-method"><p>On each call returns next colour in the spectrum. To reset it back to red call <a href="#Raphael.getColor.reset" class="dr-link">Raphael.getColor.reset</a>
1703 </p>
1704 <p class="header">Parameters
1705 </p>
1706 <dl class="dr-parameters"><dt class="dr-param optional">value</dt>
1707 <dd class="dr-optional">optional</dd>
1708 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1709 <dd class="dr-description">brightness, default is <code>0.75</code></dd>
1710 </dl>
1711 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">hex representation of the colour.</span></p>
1712 </div><div class="Raphael-getColor-reset-section"><h4 id="Raphael.getColor.reset" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.getColor.reset()<a href="#Raphael.getColor.reset" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1001 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1001">&#x27ad;</a></h4>
1713 <div class="extra" id="Raphael.getColor.reset-extra"></div></div><div class="dr-method"><p>Resets spectrum position for <a href="#Raphael.getColor" class="dr-link">Raphael.getColor</a> back to red.
1714 </p>
1715 </div><div class="Raphael-getPointAtLength-section"><h3 id="Raphael.getPointAtLength" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.getPointAtLength(path, length)<a href="#Raphael.getPointAtLength" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3305 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3305">&#x27ad;</a></h3>
1716 <div class="extra" id="Raphael.getPointAtLength-extra"></div></div><div class="dr-method"><p>Return coordinates of the point located at the given length on the given path.
1717 </p>
1718 <p class="header">Parameters
1719 </p>
1720 <dl class="dr-parameters"><dt class="dr-param">path</dt>
1721 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1722 <dd class="dr-description">SVG path string</dd>
1723 <dt class="dr-param">length</dt>
1724 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1725 <dd class="dr-description">&#160;</dd>
1726 </dl>
1727 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">representation of the point:</span></p>
1728 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">x:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">x coordinate</span>
1729 <li><span class="dr-json-key">y:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">y coordinate</span>
1730 <li><span class="dr-json-key">alpha:</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">angle of derivative</span>
1731 </ol></li><li>}</li></ol>
1732 </div><div class="Raphael-getRGB-section"><h3 id="Raphael.getRGB" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.getRGB(colour)<a href="#Raphael.getRGB" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 862 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L862">&#x27ad;</a></h3>
1733 <div class="extra" id="Raphael.getRGB-extra"></div></div><div class="dr-method"><p>Parses colour string as RGB object
1734 </p>
1735 <p class="header">Parameters
1736 </p>
1737 <dl class="dr-parameters"><dt class="dr-param">colour</dt>
1738 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1739 <dd class="dr-description">colour string in one of formats:</dd>
1740 </dl>
1741 <ul>
1742     <li>Colour name (“<code>red</code>”, “<code>green</code>”, “<code>cornflowerblue</code>”, etc)</li>
1743     <li>#••• — shortened HTML colour: (“<code>#000</code>”, “<code>#fc0</code>”, etc)</li>
1744     <li>#•••••• — full length HTML colour: (“<code>#000000</code>”, “<code>#bd2300</code>”)</li>
1745     <li>rgb(•••, •••, •••) — red, green and blue channels’ values: (“<code>rgb(200,&nbsp;100,&nbsp;0)</code>”)</li>
1746     <li>rgb(•••%, •••%, •••%) — same as above, but in %: (“<code>rgb(100%,&nbsp;175%,&nbsp;0%)</code>”)</li>
1747     <li>hsb(•••, •••, •••) — hue, saturation and brightness values: (“<code>hsb(0.5,&nbsp;0.25,&nbsp;1)</code>”)</li>
1748     <li>hsb(•••%, •••%, •••%) — same as above, but in %</li>
1749     <li>hsl(•••, •••, •••) — same as hsb</li>
1750     <li>hsl(•••%, •••%, •••%) — same as hsb</li>
1751 </ul>
1752 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">RGB object in format:</span></p>
1753 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">r</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">red,</span>
1754 <li><span class="dr-json-key">g</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">green,</span>
1755 <li><span class="dr-json-key">b</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">blue</span>
1756 <li><span class="dr-json-key">hex</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">color in HTML/CSS format: #••••••,</span>
1757 <li><span class="dr-json-key">error</span><span class="dr-type"><em class="dr-type-boolean">boolean</em></span><span class="dr-json-description">true if string can’t be parsed</span>
1758 </ol></li><li>}</li></ol>
1759 </div><div class="Raphael-getSubpath-section"><h3 id="Raphael.getSubpath" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.getSubpath(path, from, to)<a href="#Raphael.getSubpath" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3320 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3320">&#x27ad;</a></h3>
1760 <div class="extra" id="Raphael.getSubpath-extra"></div></div><div class="dr-method"><p>Return subpath of a given path from given length to given length.
1761 </p>
1762 <p class="header">Parameters
1763 </p>
1764 <dl class="dr-parameters"><dt class="dr-param">path</dt>
1765 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1766 <dd class="dr-description">SVG path string</dd>
1767 <dt class="dr-param">from</dt>
1768 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1769 <dd class="dr-description">position of the start of the segment</dd>
1770 <dt class="dr-param">to</dt>
1771 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1772 <dd class="dr-description">position of the end of the segment</dd>
1773 </dl>
1774 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">pathstring for the segment</span></p>
1775 </div><div class="Raphael-getTotalLength-section"><h3 id="Raphael.getTotalLength" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.getTotalLength(path)<a href="#Raphael.getTotalLength" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 3286 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L3286">&#x27ad;</a></h3>
1776 <div class="extra" id="Raphael.getTotalLength-extra"></div></div><div class="dr-method"><p>Returns length of the given path in pixels.
1777 </p>
1778 <p class="header">Parameters
1779 </p>
1780 <dl class="dr-parameters"><dt class="dr-param">path</dt>
1781 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1782 <dd class="dr-description">SVG path string.</dd>
1783 </dl>
1784 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">length.</span></p>
1785 </div><div class="Raphael-hsb-section"><h3 id="Raphael.hsb" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.hsb(h, s, b)<a href="#Raphael.hsb" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 944 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L944">&#x27ad;</a></h3>
1786 <div class="extra" id="Raphael.hsb-extra"></div></div><div class="dr-method"><p>Converts HSB values to hex representation of the colour.
1787 </p>
1788 <p class="header">Parameters
1789 </p>
1790 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1791 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1792 <dd class="dr-description">hue</dd>
1793 <dt class="dr-param">s</dt>
1794 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1795 <dd class="dr-description">saturation</dd>
1796 <dt class="dr-param">b</dt>
1797 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1798 <dd class="dr-description">value or brightness</dd>
1799 </dl>
1800 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">hex representation of the colour.</span></p>
1801 </div><div class="Raphael-hsb2rgb-section"><h3 id="Raphael.hsb2rgb" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.hsb2rgb(h, s, v)<a href="#Raphael.hsb2rgb" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 658 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L658">&#x27ad;</a></h3>
1802 <div class="extra" id="Raphael.hsb2rgb-extra"></div></div><div class="dr-method"><p>Converts HSB values to RGB object.
1803 </p>
1804 <p class="header">Parameters
1805 </p>
1806 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1807 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1808 <dd class="dr-description">hue</dd>
1809 <dt class="dr-param">s</dt>
1810 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1811 <dd class="dr-description">saturation</dd>
1812 <dt class="dr-param">v</dt>
1813 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1814 <dd class="dr-description">value or brightness</dd>
1815 </dl>
1816 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">RGB object in format:</span></p>
1817 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">r</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">red,</span>
1818 <li><span class="dr-json-key">g</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">green,</span>
1819 <li><span class="dr-json-key">b</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">blue,</span>
1820 <li><span class="dr-json-key">hex</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">color in HTML/CSS format: #••••••</span>
1821 </ol></li><li>}</li></ol>
1822 </div><div class="Raphael-hsl-section"><h3 id="Raphael.hsl" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.hsl(h, s, l)<a href="#Raphael.hsl" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 958 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L958">&#x27ad;</a></h3>
1823 <div class="extra" id="Raphael.hsl-extra"></div></div><div class="dr-method"><p>Converts HSL values to hex representation of the colour.
1824 </p>
1825 <p class="header">Parameters
1826 </p>
1827 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1828 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1829 <dd class="dr-description">hue</dd>
1830 <dt class="dr-param">s</dt>
1831 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1832 <dd class="dr-description">saturation</dd>
1833 <dt class="dr-param">l</dt>
1834 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1835 <dd class="dr-description">luminosity</dd>
1836 </dl>
1837 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">hex representation of the colour.</span></p>
1838 </div><div class="Raphael-hsl2rgb-section"><h3 id="Raphael.hsl2rgb" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.hsl2rgb(h, s, l)<a href="#Raphael.hsl2rgb" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 695 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L695">&#x27ad;</a></h3>
1839 <div class="extra" id="Raphael.hsl2rgb-extra"></div></div><div class="dr-method"><p>Converts HSL values to RGB object.
1840 </p>
1841 <p class="header">Parameters
1842 </p>
1843 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1844 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1845 <dd class="dr-description">hue</dd>
1846 <dt class="dr-param">s</dt>
1847 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1848 <dd class="dr-description">saturation</dd>
1849 <dt class="dr-param">l</dt>
1850 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1851 <dd class="dr-description">luminosity</dd>
1852 </dl>
1853 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">RGB object in format:</span></p>
1854 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">r</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">red,</span>
1855 <li><span class="dr-json-key">g</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">green,</span>
1856 <li><span class="dr-json-key">b</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">blue,</span>
1857 <li><span class="dr-json-key">hex</span><span class="dr-type"><em class="dr-type-string">string</em></span><span class="dr-json-description">color in HTML/CSS format: #••••••</span>
1858 </ol></li><li>}</li></ol>
1859 </div><div class="Raphael-is-section"><h3 id="Raphael.is" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.is(o, type)<a href="#Raphael.is" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 381 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L381">&#x27ad;</a></h3>
1860 <div class="extra" id="Raphael.is-extra"></div></div><div class="dr-method"><p>Handfull replacement for <code>typeof</code> operator.
1861 </p>
1862 <p class="header">Parameters
1863 </p>
1864 <dl class="dr-parameters"><dt class="dr-param">o</dt>
1865 <dd class="dr-type"><em class="dr-type-…">…</em></dd>
1866 <dd class="dr-description">any object or primitive</dd>
1867 <dt class="dr-param">type</dt>
1868 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1869 <dd class="dr-description">name of the type, i.e. “string”, “function”, “number”, etc.</dd>
1870 </dl>
1871 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-boolean">boolean</em> <span class="dr-description">is given value is of given type</span></p>
1872 </div><div class="Raphael-matrix-section"><h3 id="Raphael.matrix" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.matrix(a, b, c, d, e, f)<a href="#Raphael.matrix" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1937 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1937">&#x27ad;</a></h3>
1873 <div class="extra" id="Raphael.matrix-extra"></div></div><div class="dr-method"><p>Utility method
1874 Returns matrix based on given parameters.
1875 </p>
1876 <p class="header">Parameters
1877 </p>
1878 <dl class="dr-parameters"><dt class="dr-param">a</dt>
1879 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1880 <dd class="dr-description">&#160;</dd>
1881 <dt class="dr-param">b</dt>
1882 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1883 <dd class="dr-description">&#160;</dd>
1884 <dt class="dr-param">c</dt>
1885 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1886 <dd class="dr-description">&#160;</dd>
1887 <dt class="dr-param">d</dt>
1888 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1889 <dd class="dr-description">&#160;</dd>
1890 <dt class="dr-param">e</dt>
1891 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1892 <dd class="dr-description">&#160;</dd>
1893 <dt class="dr-param">f</dt>
1894 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1895 <dd class="dr-description">&#160;</dd>
1896 </dl>
1897 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description"><a href="#Matrix" class="dr-link">Matrix</a></span></p>
1898 </div><div class="Raphael-ninja-section"><h3 id="Raphael.ninja" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.ninja()<a href="#Raphael.ninja" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4596 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4596">&#x27ad;</a></h3>
1899 <div class="extra" id="Raphael.ninja-extra"></div></div><div class="dr-method"><p>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.
1900 Beware, that in this case plugins could stop working, because they are depending on global variable existance.
1901 </p>
1902 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Raphael object</span></p>
1903 <p class="header">Usage
1904 </p>
1905 <pre class="javascript code"><code>(<b>function</b> (local_raphael) {
1906     <b>var</b> paper<span class="s"> = </span>local_raphael(<span class="d">10</span>, <span class="d">10</span>, <span class="d">320</span>, <span class="d">200</span>);
1907     …
1908 })(Raphael.ninja());
1909 </code></pre>
1910 </div><div class="Raphael-parsePathString-section"><h3 id="Raphael.parsePathString" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.parsePathString(pathString)<a href="#Raphael.parsePathString" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1042 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1042">&#x27ad;</a></h3>
1911 <div class="extra" id="Raphael.parsePathString-extra"></div></div><div class="dr-method"><p>Utility method
1912 Parses given path string into an array of arrays of path segments.
1913 </p>
1914 <p class="header">Parameters
1915 </p>
1916 <dl class="dr-parameters"><dt class="dr-param">pathString</dt>
1917 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1918 <dd class="dr-description">path string or array of segments (in the last case it will be returned straight away)</dd>
1919 </dl>
1920 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">array of segments.</span></p>
1921 </div><div class="Raphael-parseTransformString-section"><h3 id="Raphael.parseTransformString" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.parseTransformString(TString)<a href="#Raphael.parseTransformString" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1087 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1087">&#x27ad;</a></h3>
1922 <div class="extra" id="Raphael.parseTransformString-extra"></div></div><div class="dr-method"><p>Utility method
1923 Parses given path string into an array of transformations.
1924 </p>
1925 <p class="header">Parameters
1926 </p>
1927 <dl class="dr-parameters"><dt class="dr-param">TString</dt>
1928 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1929 <dd class="dr-description">transform string or array of transformations (in the last case it will be returned straight away)</dd>
1930 </dl>
1931 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">array of transformations.</span></p>
1932 </div><div class="Raphael-path2curve-section"><h3 id="Raphael.path2curve" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.path2curve(pathString)<a href="#Raphael.path2curve" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1920 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1920">&#x27ad;</a></h3>
1933 <div class="extra" id="Raphael.path2curve-extra"></div></div><div class="dr-method"><p>Utility method
1934 Converts path to a new path where all segments are cubic bezier curves.
1935 </p>
1936 <p class="header">Parameters
1937 </p>
1938 <dl class="dr-parameters"><dt class="dr-param">pathString</dt>
1939 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1940 <dd class="dr-description">path string or array of segments</dd>
1941 </dl>
1942 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">array of segments.</span></p>
1943 </div><div class="Raphael-pathToRelative-section"><h3 id="Raphael.pathToRelative" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.pathToRelative(pathString)<a href="#Raphael.pathToRelative" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 1907 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L1907">&#x27ad;</a></h3>
1944 <div class="extra" id="Raphael.pathToRelative-extra"></div></div><div class="dr-method"><p>Utility method
1945 Converts path to relative form
1946 </p>
1947 <p class="header">Parameters
1948 </p>
1949 <dl class="dr-parameters"><dt class="dr-param">pathString</dt>
1950 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1951 <dd class="dr-description">path string or array of segments</dd>
1952 </dl>
1953 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">array of segments.</span></p>
1954 </div><div class="Raphael-rad-section"><h3 id="Raphael.rad" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.rad(deg)<a href="#Raphael.rad" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 430 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L430">&#x27ad;</a></h3>
1955 <div class="extra" id="Raphael.rad-extra"></div></div><div class="dr-method"><p>Transform angle to radians
1956 </p>
1957 <p class="header">Parameters
1958 </p>
1959 <dl class="dr-parameters"><dt class="dr-param">deg</dt>
1960 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1961 <dd class="dr-description">angle in degrees</dd>
1962 </dl>
1963 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">angle in radians.</span></p>
1964 </div><div class="Raphael-registerFont-section"><h3 id="Raphael.registerFont" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.registerFont(font)<a href="#Raphael.registerFont" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4376 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4376">&#x27ad;</a></h3>
1965 <div class="extra" id="Raphael.registerFont-extra"></div></div><div class="dr-method"><p>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.
1966 Returns original parameter, so it could be used with chaining.
1967 </p>
1968 <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>
1969 <p class="header">Parameters
1970 </p>
1971 <dl class="dr-parameters"><dt class="dr-param">font</dt>
1972 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1973 <dd class="dr-description">the font to register</dd>
1974 </dl>
1975 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">the font you passed in</span></p>
1976 <p class="header">Usage
1977 </p>
1978 <pre class="javascript code"><code>Cufon.registerFont(Raphael.registerFont({…}));
1979 </code></pre>
1980 </div><div class="Raphael-rgb-section"><h3 id="Raphael.rgb" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.rgb(r, g, b)<a href="#Raphael.rgb" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 972 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L972">&#x27ad;</a></h3>
1981 <div class="extra" id="Raphael.rgb-extra"></div></div><div class="dr-method"><p>Converts RGB values to hex representation of the colour.
1982 </p>
1983 <p class="header">Parameters
1984 </p>
1985 <dl class="dr-parameters"><dt class="dr-param">r</dt>
1986 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1987 <dd class="dr-description">red</dd>
1988 <dt class="dr-param">g</dt>
1989 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1990 <dd class="dr-description">green</dd>
1991 <dt class="dr-param">b</dt>
1992 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1993 <dd class="dr-description">blue</dd>
1994 </dl>
1995 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">hex representation of the colour.</span></p>
1996 </div><div class="Raphael-rgb2hsb-section"><h3 id="Raphael.rgb2hsb" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.rgb2hsb(r, g, b)<a href="#Raphael.rgb2hsb" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 735 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L735">&#x27ad;</a></h3>
1997 <div class="extra" id="Raphael.rgb2hsb-extra"></div></div><div class="dr-method"><p>Converts RGB values to HSB object.
1998 </p>
1999 <p class="header">Parameters
2000 </p>
2001 <dl class="dr-parameters"><dt class="dr-param">r</dt>
2002 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2003 <dd class="dr-description">red</dd>
2004 <dt class="dr-param">g</dt>
2005 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2006 <dd class="dr-description">green</dd>
2007 <dt class="dr-param">b</dt>
2008 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2009 <dd class="dr-description">blue</dd>
2010 </dl>
2011 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">HSB object in format:</span></p>
2012 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">h</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">hue</span>
2013 <li><span class="dr-json-key">s</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">saturation</span>
2014 <li><span class="dr-json-key">b</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">brightness</span>
2015 </ol></li><li>}</li></ol>
2016 </div><div class="Raphael-rgb2hsl-section"><h3 id="Raphael.rgb2hsl" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.rgb2hsl(r, g, b)<a href="#Raphael.rgb2hsl" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 769 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L769">&#x27ad;</a></h3>
2017 <div class="extra" id="Raphael.rgb2hsl-extra"></div></div><div class="dr-method"><p>Converts RGB values to HSL object.
2018 </p>
2019 <p class="header">Parameters
2020 </p>
2021 <dl class="dr-parameters"><dt class="dr-param">r</dt>
2022 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2023 <dd class="dr-description">red</dd>
2024 <dt class="dr-param">g</dt>
2025 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2026 <dd class="dr-description">green</dd>
2027 <dt class="dr-param">b</dt>
2028 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2029 <dd class="dr-description">blue</dd>
2030 </dl>
2031 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">HSL object in format:</span></p>
2032 <ol class="dr-json"><li>{<ol class="dr-json"><li><span class="dr-json-key">h</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">hue</span>
2033 <li><span class="dr-json-key">s</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">saturation</span>
2034 <li><span class="dr-json-key">l</span><span class="dr-type"><em class="dr-type-number">number</em></span><span class="dr-json-description">luminosity</span>
2035 </ol></li><li>}</li></ol>
2036 </div><div class="Raphael-setWindow-section"><h3 id="Raphael.setWindow" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.setWindow(newwin)<a href="#Raphael.setWindow" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 500 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L500">&#x27ad;</a></h3>
2037 <div class="extra" id="Raphael.setWindow-extra"></div></div><div class="dr-method"><p>Used when you need to draw in <code>&lt;iframe></code>. Switched window to the iframe one.
2038 </p>
2039 <p class="header">Parameters
2040 </p>
2041 <dl class="dr-parameters"><dt class="dr-param">newwin</dt>
2042 <dd class="dr-type"><em class="dr-type-window">window</em></dd>
2043 <dd class="dr-description">new window object</dd>
2044 </dl>
2045 </div><div class="Raphael-snapTo-section"><h3 id="Raphael.snapTo" class="dr-method"><i class="dr-trixie">&#160;</i>Raphael.snapTo(values, value, [tolerance])<a href="#Raphael.snapTo" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 456 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L456">&#x27ad;</a></h3>
2046 <div class="extra" id="Raphael.snapTo-extra"></div></div><div class="dr-method"><p>Snaps given value to given grid.
2047 </p>
2048 <p class="header">Parameters
2049 </p>
2050 <dl class="dr-parameters"><dt class="dr-param">values</dt>
2051 <dd class="dr-type"><em class="dr-type-array">array</em> <em class="dr-type-number">number</em></dd>
2052 <dd class="dr-description">given array of values or step of the grid</dd>
2053 <dt class="dr-param">value</dt>
2054 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2055 <dd class="dr-description">value to adjust</dd>
2056 <dt class="dr-param optional">tolerance</dt>
2057 <dd class="dr-optional">optional</dd>
2058 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2059 <dd class="dr-description">tolerance for snapping. Default is <code>10</code>.</dd>
2060 </dl>
2061 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">adjusted value.</span></p>
2062 </div><div class="Raphael-st-section"><h3 id="Raphael.st" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.st<a href="#Raphael.st" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4620 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4620">&#x27ad;</a></h3>
2063 <div class="extra" id="Raphael.st-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-object">object</em><p>You can add your own method to elements and sets. It is wise to add a set method for each element method
2064 you added, so you will be able to call the same method on sets too.
2065 See also <a href="#Raphael.el" class="dr-link">Raphael.el</a>.
2066 </p>
2067 <p class="header">Usage
2068 </p>
2069 <pre class="javascript code"><code>Raphael.el.red<span class="s"> = </span><b>function</b> () {
2070     <b>this</b>.attr({fill: <i>"#f00"</i>});
2071 };
2072 Raphael.st.red<span class="s"> = </span><b>function</b> () {
2073     <b>this</b>.forEach(<b>function</b> () {
2074         <b>this</b>.red();
2075     });
2076 };
2077 <span class="c">// then use it</span>
2078 paper.set(paper.circle(<span class="d">100</span>, <span class="d">100</span>, <span class="d">20</span>), paper.circle(<span class="d">110</span>, <span class="d">100</span>, <span class="d">20</span>)).red();
2079 </code></pre>
2080 </div><div class="Raphael-svg-section"><h3 id="Raphael.svg" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.svg<a href="#Raphael.svg" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 335 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L335">&#x27ad;</a></h3>
2081 <div class="extra" id="Raphael.svg-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-boolean">boolean</em><p><code>true</code> if browser supports SVG.
2082 </p>
2083 </div><div class="Raphael-type-section"><h3 id="Raphael.type" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.type<a href="#Raphael.type" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 317 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L317">&#x27ad;</a></h3>
2084 <div class="extra" id="Raphael.type-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-string">string</em><p>Can be “SVG”, “VML” or empty, depending on browser support.
2085 </p>
2086 </div><div class="Raphael-vml-section"><h3 id="Raphael.vml" class="dr-property"><i class="dr-trixie">&#160;</i>Raphael.vml<a href="#Raphael.vml" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 341 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L341">&#x27ad;</a></h3>
2087 <div class="extra" id="Raphael.vml-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-boolean">boolean</em><p><code>true</code> if browser supports VML.
2088 </p>
2089 </div><div class="Set-section"><h2 id="Set" class="undefined"><i class="dr-trixie">&#160;</i>Set<a href="#Set" title="Link to this section" class="dr-hash">&#x2693;</a></h2>
2090 <div class="extra" id="Set-extra"></div></div><div class="Set-clear-section"><h3 id="Set.clear" class="dr-method"><i class="dr-trixie">&#160;</i>Set.clear()<a href="#Set.clear" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4240 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4240">&#x27ad;</a></h3>
2091 <div class="extra" id="Set.clear-extra"></div></div><div class="dr-method"><p>Removeds all elements from the set
2092 </p>
2093 </div><div class="Set-exclude-section"><h3 id="Set.exclude" class="dr-method"><i class="dr-trixie">&#160;</i>Set.exclude(element)<a href="#Set.exclude" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4295 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4295">&#x27ad;</a></h3>
2094 <div class="extra" id="Set.exclude-extra"></div></div><div class="dr-method"><p>Removes given element from the set
2095 </p>
2096 <p class="header">Parameters
2097 </p>
2098 <dl class="dr-parameters"><dt class="dr-param">element</dt>
2099 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2100 <dd class="dr-description">element to remove</dd>
2101 </dl>
2102 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-boolean">boolean</em> <span class="dr-description"><code>true</code> if object was found <em class="amp">&amp;</em> removed from the set</span></p>
2103 </div><div class="Set-forEach-section"><h3 id="Set.forEach" class="dr-method"><i class="dr-trixie">&#160;</i>Set.forEach(callback, thisArg)<a href="#Set.forEach" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4204 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4204">&#x27ad;</a></h3>
2104 <div class="extra" id="Set.forEach-extra"></div></div><div class="dr-method"><p>Executes given function for each element in the set.
2105 </p>
2106 <p>If function returns <code>false</code> it will stop loop running.
2107 </p>
2108 <p class="header">Parameters
2109 </p>
2110 <dl class="dr-parameters"><dt class="dr-param">callback</dt>
2111 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
2112 <dd class="dr-description">function to run</dd>
2113 <dt class="dr-param">thisArg</dt>
2114 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2115 <dd class="dr-description">context object for the callback</dd>
2116 </dl>
2117 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">Set object</span></p>
2118 </div><div class="Set-pop-section"><h3 id="Set.pop" class="dr-method"><i class="dr-trixie">&#160;</i>Set.pop()<a href="#Set.pop" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4186 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4186">&#x27ad;</a></h3>
2119 <div class="extra" id="Set.pop-extra"></div></div><div class="dr-method"><p>Removes last element and returns it.
2120 </p>
2121 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">element</span></p>
2122 </div><div class="Set-push-section"><h3 id="Set.push" class="dr-method"><i class="dr-trixie">&#160;</i>Set.push()<a href="#Set.push" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4166 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4166">&#x27ad;</a></h3>
2123 <div class="extra" id="Set.push-extra"></div></div><div class="dr-method"><p>Adds each argument to the current set.
2124 </p>
2125 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">original element</span></p>
2126 </div><div class="Set-splice-section"><h3 id="Set.splice" class="dr-method"><i class="dr-trixie">&#160;</i>Set.splice(index, count, [insertion…])<a href="#Set.splice" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 4258 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/master/raphael.core.js#L4258">&#x27ad;</a></h3>
2127 <div class="extra" id="Set.splice-extra"></div></div><div class="dr-method"><p>Removes given element from the set
2128 </p>
2129 <p class="header">Parameters
2130 </p>
2131 <dl class="dr-parameters"><dt class="dr-param">index</dt>
2132 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2133 <dd class="dr-description">position of the deletion</dd>
2134 <dt class="dr-param">count</dt>
2135 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2136 <dd class="dr-description">number of element to remove</dd>
2137 <dt class="dr-param optional">insertion…</dt>
2138 <dd class="dr-optional">optional</dd>
2139 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2140 <dd class="dr-description">elements to insert</dd>
2141 </dl>
2142 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">set elements that were deleted</span></p>
2143 </div><div class="eve-section"><h2 id="eve" class="dr-method"><i class="dr-trixie">&#160;</i>eve(name, scope, varargs)<a href="#eve" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 34 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L34">&#x27ad;</a></h2>
2144 <div class="extra" id="eve-extra"></div></div><div class="dr-method"><p>Fires event with given <code>name</code>, given scope and other parameters.
2145 </p>
2146 <p class="header">Arguments
2147 </p>
2148 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2149 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2150 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated</dd>
2151 <dt class="dr-param">scope</dt>
2152 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2153 <dd class="dr-description">context for the event handlers</dd>
2154 <dt class="dr-param">varargs</dt>
2155 <dd class="dr-type"><em class="dr-type-...">...</em></dd>
2156 <dd class="dr-description">the rest of arguments will be sent to event handlers</dd>
2157 </dl>
2158 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">array of returned values from the listeners</span></p>
2159 </div><div class="eve-listeners-section"><h3 id="eve.listeners" class="dr-method"><i class="dr-trixie">&#160;</i>eve.listeners(name)<a href="#eve.listeners" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 107 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L107">&#x27ad;</a></h3>
2160 <div class="extra" id="eve.listeners-extra"></div></div><div class="dr-method"><p>Internal method which gives you array of all event handlers that will be triggered by the given <code>name</code>.
2161 </p>
2162 <p class="header">Arguments
2163 </p>
2164 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2165 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2166 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated</dd>
2167 </dl>
2168 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-array">array</em> <span class="dr-description">array of event handlers</span></p>
2169 </div><div class="eve-nt-section"><h3 id="eve.nt" class="dr-method"><i class="dr-trixie">&#160;</i>eve.nt([subname])<a href="#eve.nt" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 204 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L204">&#x27ad;</a></h3>
2170 <div class="extra" id="eve.nt-extra"></div></div><div class="dr-method"><p>Could be used inside event handler to figure out actual name of the event.
2171 </p>
2172 <p class="header">Arguments
2173 </p>
2174 <dl class="dr-parameters"><dt class="dr-param optional">subname</dt>
2175 <dd class="dr-optional">optional</dd>
2176 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2177 <dd class="dr-description">subname of the event</dd>
2178 </dl>
2179 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-string">string</em> <span class="dr-description">name of the event, if <code>subname</code> is not specified</span></p>
2180 <p>or
2181 </p>
2182 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-boolean">boolean</em> <span class="dr-description"><code>true</code>, if current event’s name contains <code>subname</code></span></p>
2183 </div><div class="eve-on-section"><h3 id="eve.on" class="dr-method"><i class="dr-trixie">&#160;</i>eve.on(name, f)<a href="#eve.on" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 162 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L162">&#x27ad;</a></h3>
2184 <div class="extra" id="eve.on-extra"></div></div><div class="dr-method"><p>Binds given event handler with a given name. You can use wildcards “<code>*</code>” for the names:
2185 </p>
2186 <pre class="javascript code"><code>eve.on(<i>"*.under.*"</i>, f);
2187 eve(<i>"mouse.under.floor"</i>); <span class="c">// triggers f</span>
2188 </code></pre>
2189 <p>Use <a href="#eve" class="dr-link">eve</a> to trigger the listener.
2190 </p>
2191 <p class="header">Arguments
2192 </p>
2193 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2194 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2195 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated, with optional wildcards</dd>
2196 <dt class="dr-param">f</dt>
2197 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
2198 <dd class="dr-description">event handler function</dd>
2199 </dl>
2200 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-function">function</em> <span class="dr-description">returned function accept one number parameter that represents z-index of the handler. It is optional feature and only used when you need to ensure that some subset of handlers will be invoked in a given order, despite of the order of assignment. </span></p>
2201 <p class="header">Example:
2202 </p>
2203 <pre class="javascript code"><code>eve.on(<i>"mouse"</i>, eat)(<span class="d">2</span>);
2204 eve.on(<i>"mouse"</i>, scream);
2205 eve.on(<i>"mouse"</i>, <b>catch</b>)(<span class="d">1</span>);
2206 </code></pre>
2207 <p>This will ensure that <code>catch</code> function will be called before <code>eat</code>.
2208 If you want to put you hadler before not indexed handlers specify negative value.
2209 Note: I assume most of the time you don’t need to worry about z-index, but it’s nice to have this feature “just in case”.
2210 </p>
2211 </div><div class="eve-stop-section"><h3 id="eve.stop" class="dr-method"><i class="dr-trixie">&#160;</i>eve.stop()<a href="#eve.stop" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 187 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L187">&#x27ad;</a></h3>
2212 <div class="extra" id="eve.stop-extra"></div></div><div class="dr-method"><p>Is used inside event handler to stop event
2213 </p>
2214 </div><div class="eve-unbind-section"><h3 id="eve.unbind" class="dr-method"><i class="dr-trixie">&#160;</i>eve.unbind(name, f)<a href="#eve.unbind" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 221 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L221">&#x27ad;</a></h3>
2215 <div class="extra" id="eve.unbind-extra"></div></div><div class="dr-method"><p>Removes given function from the list of event listeners assigned to given name.
2216 </p>
2217 <p class="header">Arguments
2218 </p>
2219 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2220 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2221 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated, with optional wildcards</dd>
2222 <dt class="dr-param">f</dt>
2223 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
2224 <dd class="dr-description">event handler function</dd>
2225 </dl>
2226 </div><div class="eve-version-section"><h3 id="eve.version" class="dr-property"><i class="dr-trixie">&#160;</i>eve.version<a href="#eve.version" title="Link to this section" class="dr-hash">&#x2693;</a><a class="dr-sourceline" title="Go to line 278 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L278">&#x27ad;</a></h3>
2227 <div class="extra" id="eve.version-extra"></div></div><div class="dr-property"><em class="dr-type dr-type-string">string</em><p>Current version of the library.
2228 </p>
2229 </div></div></div>
2230 <script src="raphael.js"></script>
2231 <script src="reference.js"></script>
2232 </body></html>