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 2.0 Reference</title><link rel="stylesheet" href="dr.css"></head><body id="dr-js"><div id="dr"><ol class="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.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.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 2.0 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"></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 3602 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3602">&#x27ad;</a></h3>
   5 <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 </div><div class="extra"></div></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 3620 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3620">&#x27ad;</a></h3>
  15 <div class="dr-method"><p>Creates a copy of existing animation object with given repetition.
  16 </p>
  17 <p class="header">Parameters
  18 </p>
  19 <dl class="dr-parameters"><dt class="dr-param">repeat</dt>
  20 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  21 <dd class="dr-description">number iterations of animation. For infinite animation pass <code>Infinity</code></dd>
  22 </dl>
  23 <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>
  24 </div><div class="extra"></div></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>
  25 <div class="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 3890 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3890">&#x27ad;</a></h3>
  26 <div class="dr-method"><p>Creates and starts animation for given element.
  27 </p>
  28 <p class="header">Parameters
  29 </p>
  30 <dl class="dr-parameters"><dt class="dr-param">params</dt>
  31 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  32 <dd class="dr-description">final attributes for the element, see also <a href="#Element.attr" class="dr-link">Element.attr</a></dd>
  33 <dt class="dr-param">ms</dt>
  34 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  35 <dd class="dr-description">number of milliseconds for animation to run</dd>
  36 <dt class="dr-param optional">easing</dt>
  37 <dd class="dr-optional">optional</dd>
  38 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
  39 <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>
  40 <dt class="dr-param optional">callback</dt>
  41 <dd class="dr-optional">optional</dd>
  42 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
  43 <dd class="dr-description">callback function. Will be called at the end of animation.</dd>
  44 </dl>
  45 <p>or
  46 </p>
  47 <dl class="dr-parameters"><dt class="dr-param">animation</dt>
  48 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  49 <dd class="dr-description">animation object, see <a href="#Raphael.animation" class="dr-link">Raphael.animation</a></dd>
  50 </dl>
  51 <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>
  52 </div><div class="extra"></div></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 3515 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3515">&#x27ad;</a></h3>
  53 <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.
  54 </p>
  55 <p class="header">Parameters
  56 </p>
  57 <dl class="dr-parameters"><dt class="dr-param">element</dt>
  58 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  59 <dd class="dr-description">element to sync with</dd>
  60 <dt class="dr-param">anim</dt>
  61 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  62 <dd class="dr-description">animation to sync with</dd>
  63 <dt class="dr-param optional">params</dt>
  64 <dd class="dr-optional">optional</dd>
  65 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  66 <dd class="dr-description">final attributes for the element, see also <a href="#Element.attr" class="dr-link">Element.attr</a></dd>
  67 <dt class="dr-param optional">ms</dt>
  68 <dd class="dr-optional">optional</dd>
  69 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
  70 <dd class="dr-description">number of milliseconds for animation to run</dd>
  71 <dt class="dr-param optional">easing</dt>
  72 <dd class="dr-optional">optional</dd>
  73 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
  74 <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>
  75 <dt class="dr-param optional">callback</dt>
  76 <dd class="dr-optional">optional</dd>
  77 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
  78 <dd class="dr-description">callback function. Will be called at the end of animation.</dd>
  79 </dl>
  80 <p>or
  81 </p>
  82 <dl class="dr-parameters"><dt class="dr-param">element</dt>
  83 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  84 <dd class="dr-description">element to sync with</dd>
  85 <dt class="dr-param">anim</dt>
  86 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  87 <dd class="dr-description">animation to sync with</dd>
  88 <dt class="dr-param optional">animation</dt>
  89 <dd class="dr-optional">optional</dd>
  90 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
  91 <dd class="dr-description">animation object, see <a href="#Raphael.animation" class="dr-link">Raphael.animation</a></dd>
  92 </dl>
  93 <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>
  94 </div><div class="extra"></div></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 979 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L979">&#x27ad;</a></h3>
  95 <div class="dr-method"><p>Sets the attributes of the element.
  96 </p>
  97 <p class="header">Parameters
  98 </p>
  99 <dl class="dr-parameters"><dt class="dr-param">attrName</dt>
 100 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 101 <dd class="dr-description">attribute’s name</dd>
 102 <dt class="dr-param">value</dt>
 103 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 104 <dd class="dr-description">value</dd>
 105 </dl>
 106 <p>or
 107 </p>
 108 <dl class="dr-parameters"><dt class="dr-param">params</dt>
 109 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 110 <dd class="dr-description">object of name/value pairs</dd>
 111 </dl>
 112 <p>or
 113 </p>
 114 <dl class="dr-parameters"><dt class="dr-param">attrName</dt>
 115 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 116 <dd class="dr-description">attribute’s name</dd>
 117 </dl>
 118 <p>or
 119 </p>
 120 <dl class="dr-parameters"><dt class="dr-param">attrNames</dt>
 121 <dd class="dr-type"><em class="dr-type-array">array</em></dd>
 122 <dd class="dr-description">in this case method returns array of current values for given attribute names</dd>
 123 </dl>
 124 <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>
 125 <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>
 126 <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>
 127 <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>
 128 <p class="header">Possible parameters
 129 </p>
 130 <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>
 131 <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>
 132 <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>
 133 <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>
 134 <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>
 135 <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>
 136 <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>
 137 <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>
 138 <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>
 139 <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>
 140 <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>
 141 <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>
 142 <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>
 143 <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>
 144 <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>
 145 <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>
 146 <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>
 147 <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>
 148 <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>
 149 <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>
 150 <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>
 151 <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>
 152 <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>
 153 <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>
 154 <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>
 155 <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>
 156 <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>
 157 <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>
 158 <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>
 159 <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>
 160 <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>
 161 <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>
 162 <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>
 163 <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>
 164 <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>
 165 </ol>
 166 <p class="header">Gradients
 167 <p>Linear gradient format: “<code>‹angle›-‹colour›[-‹colour›[:‹offset›]]*-‹colour›</code>”, example: “<code>90-#fff-#000</code>” – 90°
 168 gradient from white to black or “<code>0-#fff-#f00:20-#000</code>” – 0° gradient from white via red (at 20%) to black.
 169 </p>
 170 <p>radial gradient: “<code>r[(‹fx›, ‹fy›)]‹colour›[-‹colour›[:‹offset›]]*-‹colour›</code>”, example: “<code>r#fff-#000</code>” –
 171 gradient from white to black or “<code>r(0.25, 0.75)#fff-#000</code>” – gradient from white to black with focus point
 172 at 0.25, 0.75. Focus point coordinates are in 0..1 range. Radial gradients can only be applied to circles and ellipses.
 173 </p>
 174 <p class="header">Path String
 175 </p>
 176 <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>
 177 <p class="header">Colour Parsing
 178 </p>
 179 <ul>
 180     <li>Colour name (“<code>red</code>”, “<code>green</code>”, “<code>cornflowerblue</code>”, etc)</li>
 181     <li>#••• — shortened HTML colour: (“<code>#000</code>”, “<code>#fc0</code>”, etc)</li>
 182     <li>#•••••• — full length HTML colour: (“<code>#000000</code>”, “<code>#bd2300</code>”)</li>
 183     <li>rgb(•••, •••, •••) — red, green and blue channels’ values: (“<code>rgb(200,&nbsp;100,&nbsp;0)</code>”)</li>
 184     <li>rgb(•••%, •••%, •••%) — same as above, but in %: (“<code>rgb(100%,&nbsp;175%,&nbsp;0%)</code>”)</li>
 185     <li>rgba(•••, •••, •••, •••) — red, green and blue channels’ values: (“<code>rgba(200,&nbsp;100,&nbsp;0, .5)</code>”)</li>
 186     <li>rgba(•••%, •••%, •••%, •••%) — same as above, but in %: (“<code>rgba(100%,&nbsp;175%,&nbsp;0%, 50%)</code>”)</li>
 187     <li>hsb(•••, •••, •••) — hue, saturation and brightness values: (“<code>hsb(0.5,&nbsp;0.25,&nbsp;1)</code>”)</li>
 188     <li>hsb(•••%, •••%, •••%) — same as above, but in %</li>
 189     <li>hsba(•••, •••, •••, •••) — same as above, but with opacity</li>
 190     <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>
 191     <li>hsl(•••%, •••%, •••%) — same as above, but in %</li>
 192     <li>hsla(•••, •••, •••, •••) — same as above, but with opacity</li>
 193     <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>
 194 </ul>
 195 </div><div class="extra"></div></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 2262 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2262">&#x27ad;</a></h3>
 196 <div class="dr-method"><p>Adds event handler for click for the element.
 197 </p>
 198 <p class="header">Parameters
 199 </p>
 200 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 201 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 202 <dd class="dr-description">handler for the event</dd>
 203 </dl>
 204 <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>
 205 </div><div class="extra"></div></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 3044 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3044">&#x27ad;</a></h3>
 206 <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>
 207 </div><div class="extra"></div></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 2507 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2507">&#x27ad;</a></h3>
 208 <div class="dr-method"><p>Adds or retrieves given value asociated with given key.
 209 See also <a href="#Element.removeData" class="dr-link">Element.removeData</a>
 210 </p>
 211 <p class="header">Parameters
 212 </p>
 213 <dl class="dr-parameters"><dt class="dr-param">key</dt>
 214 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 215 <dd class="dr-description">key to store data</dd>
 216 <dt class="dr-param optional">value</dt>
 217 <dd class="dr-optional">optional</dd>
 218 <dd class="dr-type"><em class="dr-type-any">any</em></dd>
 219 <dd class="dr-description">value to store</dd>
 220 </dl>
 221 <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>
 222 <p>or, if value is not specified:
 223 </p>
 224 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-any">any</em> <span class="dr-description">value</span></p>
 225 <p class="header">Usage
 226 </p>
 227 <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++) {
 228     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>)
 229          .attr({fill: <i>"#<span class="d">000</span>"</i>})
 230          .data(<i>"i"</i>, i)
 231          .click(<b>function</b> () {
 232             alert(<b>this</b>.data(<i>"i"</i>));
 233          });
 234 }
 235 </code></pre>
 236 </div><div class="extra"></div></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 2281 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2281">&#x27ad;</a></h3>
 237 <div class="dr-method"><p>Adds event handler for double click for the element.
 238 </p>
 239 <p class="header">Parameters
 240 </p>
 241 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 242 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 243 <dd class="dr-description">handler for the event</dd>
 244 </dl>
 245 <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>
 246 </div><div class="extra"></div></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 2599 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2599">&#x27ad;</a></h3>
 247 <div class="dr-method"><p>Adds event handlers for drag of the element.
 248 </p>
 249 <p class="header">Parameters
 250 </p>
 251 <dl class="dr-parameters"><dt class="dr-param">onmove</dt>
 252 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 253 <dd class="dr-description">handler for moving</dd>
 254 <dt class="dr-param">onstart</dt>
 255 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 256 <dd class="dr-description">handler for drag start</dd>
 257 <dt class="dr-param">onend</dt>
 258 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 259 <dd class="dr-description">handler for drag end</dd>
 260 <dt class="dr-param optional">mcontext</dt>
 261 <dd class="dr-optional">optional</dd>
 262 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 263 <dd class="dr-description">context for moving handler</dd>
 264 <dt class="dr-param optional">scontext</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 drag start handler</dd>
 268 <dt class="dr-param optional">econtext</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 end handler</dd>
 272 </dl>
 273 <p>Additionaly following <code>drag</code> events will be triggered: <code>drag.start.&lt;id></code> on start,
 274 <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
 275 <code>drag.over.&lt;id></code> will be fired as well.
 276 </p>
 277 <p>Start event and start handler will be called in specified context or in context of the element with following parameters:
 278 </p>
 279 <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>
 280 <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>
 281 <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>
 282 </ol>
 283 <p>Move event and move handler will be called in specified context or in context of the element with following parameters:
 284 </p>
 285 <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>
 286 <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>
 287 <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>
 288 <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>
 289 <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>
 290 </ol>
 291 <p>End event and end handler will be called in specified context or in context of the element with following parameters:
 292 </p>
 293 <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>
 294 </ol>
 295 <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>
 296 </div><div class="extra"></div></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 3012 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3012">&#x27ad;</a></h3>
 297 <div class="dr-method"><p>Return bounding box for a given element
 298 </p>
 299 <p class="header">Parameters
 300 </p>
 301 <dl class="dr-parameters"><dt class="dr-param">isWithoutTransform</dt>
 302 <dd class="dr-type"><em class="dr-type-boolean">boolean</em></dd>
 303 <dd class="dr-description">flag, <code>true</code> if you want to have bounding box before transformations. Default is <code>false</code>.</dd>
 304 </dl>
 305 <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>
 306 <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>
 307 <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>
 308 <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>
 309 <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>
 310 </ol></li><li>}</li></ol>
 311 </div><div class="extra"></div></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 3262 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3262">&#x27ad;</a></h3>
 312 <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.
 313 </p>
 314 <p class="header">Parameters
 315 </p>
 316 <dl class="dr-parameters"><dt class="dr-param">length</dt>
 317 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 318 <dd class="dr-description">&#160;</dd>
 319 </dl>
 320 <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>
 321 <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>
 322 <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>
 323 <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>
 324 </ol></li><li>}</li></ol>
 325 </div><div class="extra"></div></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 3279 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3279">&#x27ad;</a></h3>
 326 <div class="dr-method"><p>Return subpath of a given element from given length to given length. Only works for element of “path” type.
 327 </p>
 328 <p class="header">Parameters
 329 </p>
 330 <dl class="dr-parameters"><dt class="dr-param">from</dt>
 331 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 332 <dd class="dr-description">position of the start of the segment</dd>
 333 <dt class="dr-param">to</dt>
 334 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 335 <dd class="dr-description">position of the end of the segment</dd>
 336 </dl>
 337 <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>
 338 </div><div class="extra"></div></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 3238 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3238">&#x27ad;</a></h3>
 339 <div class="dr-method"><p>Returns length of the path in pixels. Only works for element of “path” type.
 340 </p>
 341 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">length.</span></p>
 342 </div><div class="extra"></div></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 3071 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3071">&#x27ad;</a></h3>
 343 <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>.
 344 </p>
 345 <p>Note: Glow is not connected to the element. If you change element attributes it won’t adjust itself.
 346 </p>
 347 <p class="header">Parameters
 348 </p>
 349 <dl class="dr-parameters"><dt class="dr-param optional">glow</dt>
 350 <dd class="dr-optional">optional</dd>
 351 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 352 <dd class="dr-description">parameters object with all properties optional:</dd>
 353 </dl>
 354 <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>
 355 <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>
 356 <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>
 357 <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>
 358 <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>
 359 <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>
 360 </ol></li><li>}</li></ol>
 361 <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>
 362 </div><div class="extra"></div></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 849 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L849">&#x27ad;</a></h3>
 363 <div class="dr-method"><p>Makes element invisible. See <a href="#Element.show" class="dr-link">Element.show</a>.
 364 </p>
 365 <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>
 366 </div><div class="extra"></div></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 2553 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2553">&#x27ad;</a></h3>
 367 <div class="dr-method"><p>Adds event handlers for hover for the element.
 368 </p>
 369 <p class="header">Parameters
 370 </p>
 371 <dl class="dr-parameters"><dt class="dr-param">f_in</dt>
 372 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 373 <dd class="dr-description">handler for hover in</dd>
 374 <dt class="dr-param">f_out</dt>
 375 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 376 <dd class="dr-description">handler for hover out</dd>
 377 <dt class="dr-param optional">icontext</dt>
 378 <dd class="dr-optional">optional</dd>
 379 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 380 <dd class="dr-description">context for hover in handler</dd>
 381 <dt class="dr-param optional">ocontext</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 out handler</dd>
 385 </dl>
 386 <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>
 387 </div><div class="extra"></div></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/2.0/raphael.svg.js#L637">&#x27ad;</a></h3>
 388 <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,
 389 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.
 390 </p>
 391 </div><div class="extra"></div></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 1077 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1077">&#x27ad;</a></h3>
 392 <div class="dr-method"><p>Inserts current object after the given one.
 393 </p>
 394 <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>
 395 </div><div class="extra"></div></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 1097 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1097">&#x27ad;</a></h3>
 396 <div class="dr-method"><p>Inserts current object before 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="extra"></div></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 2300 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2300">&#x27ad;</a></h3>
 400 <div class="dr-method"><p>Adds event handler for mousedown for the element.
 401 </p>
 402 <p class="header">Parameters
 403 </p>
 404 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 405 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 406 <dd class="dr-description">handler for the event</dd>
 407 </dl>
 408 <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>
 409 </div><div class="extra"></div></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 2319 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2319">&#x27ad;</a></h3>
 410 <div class="dr-method"><p>Adds event handler for mousemove for the element.
 411 </p>
 412 <p class="header">Parameters
 413 </p>
 414 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 415 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 416 <dd class="dr-description">handler for the event</dd>
 417 </dl>
 418 <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>
 419 </div><div class="extra"></div></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 2338 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2338">&#x27ad;</a></h3>
 420 <div class="dr-method"><p>Adds event handler for mouseout for the element.
 421 </p>
 422 <p class="header">Parameters
 423 </p>
 424 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 425 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 426 <dd class="dr-description">handler for the event</dd>
 427 </dl>
 428 <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>
 429 </div><div class="extra"></div></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 2357 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2357">&#x27ad;</a></h3>
 430 <div class="dr-method"><p>Adds event handler for mouseover for the element.
 431 </p>
 432 <p class="header">Parameters
 433 </p>
 434 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 435 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 436 <dd class="dr-description">handler for the event</dd>
 437 </dl>
 438 <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>
 439 </div><div class="extra"></div></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 2376 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2376">&#x27ad;</a></h3>
 440 <div class="dr-method"><p>Adds event handler for mouseup for the element.
 441 </p>
 442 <p class="header">Parameters
 443 </p>
 444 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 445 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 446 <dd class="dr-description">handler for the event</dd>
 447 </dl>
 448 <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>
 449 </div><div class="extra"></div></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/2.0/raphael.svg.js#L680">&#x27ad;</a></h3>
 450 <div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Reference to the next element in the hierarchy.
 451 </p>
 452 </div><div class="extra"></div></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/2.0/raphael.svg.js#L616">&#x27ad;</a></h3>
 453 <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.
 454 Note: Don’t mess with it.
 455 </p>
 456 <p class="header">Usage
 457 </p>
 458 <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>
 459 <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>);
 460 c.node.onclick<span class="s"> = </span><b>function</b> () {
 461     c.attr(<i>"fill"</i>, <i>"red"</i>);
 462 };
 463 </code></pre>
 464 </div><div class="extra"></div></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 2626 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2626">&#x27ad;</a></h3>
 465 <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>).
 466 </p>
 467 <p class="header">Parameters
 468 </p>
 469 <dl class="dr-parameters"><dt class="dr-param">f</dt>
 470 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 471 <dd class="dr-description">handler for event</dd>
 472 </dl>
 473 </div><div class="extra"></div></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/2.0/raphael.svg.js#L653">&#x27ad;</a></h3>
 474 <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.
 475 </p>
 476 <p class="header">Usage
 477 </p>
 478 <pre class="javascript code"><code>Raphael.el.cross<span class="s"> = </span><b>function</b> () {
 479     <b>this</b>.attr({fill: <i>"red"</i>});
 480     <b>this</b>.paper.path(<i>"M10,10L50,50M50,10L10,<span class="d">50</span>"</i>)
 481         .attr({stroke: <i>"red"</i>});
 482 }
 483 </code></pre>
 484 </div><div class="extra"></div></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 3983 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3983">&#x27ad;</a></h3>
 485 <div class="dr-method"><p>Stops animation of the element with ability to resume it later on.
 486 </p>
 487 <p class="header">Parameters
 488 </p>
 489 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 490 <dd class="dr-optional">optional</dd>
 491 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 492 <dd class="dr-description">animation object</dd>
 493 </dl>
 494 <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>
 495 </div><div class="extra"></div></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/2.0/raphael.svg.js#L671">&#x27ad;</a></h3>
 496 <div class="dr-property"><em class="dr-type dr-type-object">object</em><p>Reference to the previous element in the hierarchy.
 497 </p>
 498 </div><div class="extra"></div></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/2.0/raphael.svg.js#L629">&#x27ad;</a></h3>
 499 <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.
 500 </p>
 501 <p class="header">Usage
 502 </p>
 503 <pre class="javascript code"><code>Raphael.el.red<span class="s"> = </span><b>function</b> () {
 504     <b>var</b> hsb<span class="s"> = </span><b>this</b>.paper.raphael.rgb2hsb(<b>this</b>.attr(<i>"fill"</i>));
 505     hsb.h<span class="s"> = </span><span class="d">1</span>;
 506     <b>this</b>.attr({fill: <b>this</b>.paper.raphael.hsb2rgb(hsb).hex});
 507 }
 508 </code></pre>
 509 </div><div class="extra"></div></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 870 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L870">&#x27ad;</a></h3>
 510 <div class="dr-method"><p>Removes element form the paper.
 511 </p>
 512 </div><div class="extra"></div></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 2533 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2533">&#x27ad;</a></h3>
 513 <div class="dr-method"><p>Removes value associated with an element by given key.
 514 If key is not provided, removes all the data of the element.
 515 </p>
 516 <p class="header">Parameters
 517 </p>
 518 <dl class="dr-parameters"><dt class="dr-param optional">key</dt>
 519 <dd class="dr-optional">optional</dd>
 520 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 521 <dd class="dr-description">key</dd>
 522 </dl>
 523 <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>
 524 </div><div class="extra"></div></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 4003 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4003">&#x27ad;</a></h3>
 525 <div class="dr-method"><p>Resumes animation if it was paused with <a href="#Element.pause" class="dr-link">Element.pause</a> method.
 526 </p>
 527 <p class="header">Parameters
 528 </p>
 529 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 530 <dd class="dr-optional">optional</dd>
 531 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 532 <dd class="dr-description">animation object</dd>
 533 </dl>
 534 <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>
 535 </div><div class="extra"></div></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/2.0/raphael.svg.js#L712">&#x27ad;</a></h3>
 536 <div class="dr-method"><p>Adds rotation by given angle around given point to the list of
 537 transformations of the element.
 538 </p>
 539 <p class="header">Parameters
 540 </p>
 541 <dl class="dr-parameters"><dt class="dr-param">deg</dt>
 542 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 543 <dd class="dr-description">angle in degrees</dd>
 544 <dt class="dr-param optional">cx</dt>
 545 <dd class="dr-optional">optional</dd>
 546 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 547 <dd class="dr-description">x coordinate of the centre of rotation</dd>
 548 <dt class="dr-param optional">cy</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">y coordinate of the centre of rotation</dd>
 552 </dl>
 553 <p>If cx <em class="amp">&amp;</em> cy aren’t specified centre of the shape is used as a point of rotation.
 554 </p>
 555 <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>
 556 </div><div class="extra"></div></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/2.0/raphael.svg.js#L745">&#x27ad;</a></h3>
 557 <div class="dr-method"><p>Adds scale by given amount relative to given point to the list of
 558 transformations of the element.
 559 </p>
 560 <p class="header">Parameters
 561 </p>
 562 <dl class="dr-parameters"><dt class="dr-param">sx</dt>
 563 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 564 <dd class="dr-description">horisontal scale amount</dd>
 565 <dt class="dr-param">sy</dt>
 566 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 567 <dd class="dr-description">vertical scale amount</dd>
 568 <dt class="dr-param optional">cx</dt>
 569 <dd class="dr-optional">optional</dd>
 570 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 571 <dd class="dr-description">x coordinate of the centre of scale</dd>
 572 <dt class="dr-param optional">cy</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">y coordinate of the centre of scale</dd>
 576 </dl>
 577 <p>If cx <em class="amp">&amp;</em> cy aren’t specified centre of the shape is used instead.
 578 </p>
 579 <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>
 580 </div><div class="extra"></div></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 3916 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3916">&#x27ad;</a></h3>
 581 <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.
 582 </p>
 583 <p class="header">Parameters
 584 </p>
 585 <dl class="dr-parameters"><dt class="dr-param">anim</dt>
 586 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 587 <dd class="dr-description">animation object</dd>
 588 <dt class="dr-param">value</dt>
 589 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 590 <dd class="dr-description">number of milliseconds from the beginning of the animation</dd>
 591 </dl>
 592 <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>
 593 <p>Note, that during animation following events are triggered:
 594 </p>
 595 <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>.
 596 </p>
 597 </div><div class="extra"></div></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 860 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L860">&#x27ad;</a></h3>
 598 <div class="dr-method"><p>Makes element visible. See <a href="#Element.hide" class="dr-link">Element.hide</a>.
 599 </p>
 600 <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>
 601 </div><div class="extra"></div></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 3943 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3943">&#x27ad;</a></h3>
 602 <div class="dr-method"><p>Gets or sets the status of animation of the element.
 603 </p>
 604 <p class="header">Parameters
 605 </p>
 606 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 607 <dd class="dr-optional">optional</dd>
 608 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 609 <dd class="dr-description">animation object</dd>
 610 <dt class="dr-param optional">value</dt>
 611 <dd class="dr-optional">optional</dd>
 612 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 613 <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>
 614 </dl>
 615 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">status</span></p>
 616 <p>or
 617 </p>
 618 <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>
 619 <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>
 620 <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>
 621 </ol></li><li>}</li></ol>
 622 <p>or
 623 </p>
 624 <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>
 625 </div><div class="extra"></div></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 4025 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4025">&#x27ad;</a></h3>
 626 <div class="dr-method"><p>Stops animation of the element.
 627 </p>
 628 <p class="header">Parameters
 629 </p>
 630 <dl class="dr-parameters"><dt class="dr-param optional">anim</dt>
 631 <dd class="dr-optional">optional</dd>
 632 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 633 <dd class="dr-description">animation object</dd>
 634 </dl>
 635 <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>
 636 </div><div class="extra"></div></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 1059 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1059">&#x27ad;</a></h3>
 637 <div class="dr-method"><p>Moves the element so it is the furthest from the viewer’s eyes, behind other elements.
 638 </p>
 639 <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>
 640 </div><div class="extra"></div></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 1043 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1043">&#x27ad;</a></h3>
 641 <div class="dr-method"><p>Moves the element so it is the closest to the viewer’s eyes, on top of 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="extra"></div></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 2452 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2452">&#x27ad;</a></h3>
 645 <div class="dr-method"><p>Adds event handler for touchcancel for the element.
 646 </p>
 647 <p class="header">Parameters
 648 </p>
 649 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 650 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 651 <dd class="dr-description">handler for the event</dd>
 652 </dl>
 653 <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>
 654 </div><div class="extra"></div></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 2433 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2433">&#x27ad;</a></h3>
 655 <div class="dr-method"><p>Adds event handler for touchend for the element.
 656 </p>
 657 <p class="header">Parameters
 658 </p>
 659 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 660 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 661 <dd class="dr-description">handler for the event</dd>
 662 </dl>
 663 <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>
 664 </div><div class="extra"></div></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 2414 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2414">&#x27ad;</a></h3>
 665 <div class="dr-method"><p>Adds event handler for touchmove for the element.
 666 </p>
 667 <p class="header">Parameters
 668 </p>
 669 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 670 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 671 <dd class="dr-description">handler for the event</dd>
 672 </dl>
 673 <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>
 674 </div><div class="extra"></div></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 2395 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2395">&#x27ad;</a></h3>
 675 <div class="dr-method"><p>Adds event handler for touchstart for the element.
 676 </p>
 677 <p class="header">Parameters
 678 </p>
 679 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 680 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 681 <dd class="dr-description">handler for the event</dd>
 682 </dl>
 683 <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>
 684 </div><div class="extra"></div></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 824 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L824">&#x27ad;</a></h3>
 685 <div class="dr-method"><p>Adds transformation to the element which is separate to other attributes,
 686 i.e. translation doesn’t change <code>x</code> or <code>y</code> of the rectange. The format
 687 of transformation string is similar to the path string syntax:
 688 </p>
 689 <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>
 690 </code></pre>
 691 <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
 692 scale and <code>m</code> is for matrix.
 693 </p>
 694 <p>So, the example line above could be read like “translate by 100, 100; rotate 30° around 100, 100; scale twice around 100, 100;
 695 rotate 45° around centre; scale 1.5 times relative to centre”. As you can see rotate and scale commands have origin
 696 coordinates as optional parameters, the default is the centre point of the element.
 697 Matrix accepts six parameters.
 698 </p>
 699 <p class="header">Usage
 700 </p>
 701 <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>);
 702 <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>
 703 el.transform(<i>"t100,100r45t-<span class="d">100</span>,<span class="d">0</span>"</i>);
 704 <span class="c">// <b>if</b> you want you can append or prepend transformations</span>
 705 el.transform(<i>"...t50,<span class="d">50</span>"</i>);
 706 el.transform(<i>"s2..."</i>);
 707 <span class="c">// or even wrap</span>
 708 el.transform(<i>"t50,<span class="d">50</span>...t-<span class="d">50</span>-<span class="d">50</span>"</i>);
 709 <span class="c">// to reset transformation call method <b>with</b> empty string</span>
 710 el.transform(<i>""</i>);
 711 <span class="c">// to get current value call it without parameters</span>
 712 console.log(el.transform());
 713 </code></pre>
 714 <p class="header">Parameters
 715 </p>
 716 <dl class="dr-parameters"><dt class="dr-param optional">tstr</dt>
 717 <dd class="dr-optional">optional</dd>
 718 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
 719 <dd class="dr-description">transformation string</dd>
 720 </dl>
 721 <p>If tstr isn’t specified
 722 </p>
 723 <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>
 724 <p>else
 725 </p>
 726 <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>
 727 </div><div class="extra"></div></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/2.0/raphael.svg.js#L776">&#x27ad;</a></h3>
 728 <div class="dr-method"><p>Adds translation by given amount to the list of transformations of the element.
 729 </p>
 730 <p class="header">Parameters
 731 </p>
 732 <dl class="dr-parameters"><dt class="dr-param">dx</dt>
 733 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 734 <dd class="dr-description">horisontal shift</dd>
 735 <dt class="dr-param">dy</dt>
 736 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 737 <dd class="dr-description">vertical shift</dd>
 738 </dl>
 739 <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>
 740 </div><div class="extra"></div></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 2271 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2271">&#x27ad;</a></h3>
 741 <div class="dr-method"><p>Removes event handler for click for the element.
 742 </p>
 743 <p class="header">Parameters
 744 </p>
 745 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 746 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 747 <dd class="dr-description">handler for the event</dd>
 748 </dl>
 749 <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>
 750 </div><div class="extra"></div></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 2290 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2290">&#x27ad;</a></h3>
 751 <div class="dr-method"><p>Removes event handler for double click for the element.
 752 </p>
 753 <p class="header">Parameters
 754 </p>
 755 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 756 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 757 <dd class="dr-description">handler for the event</dd>
 758 </dl>
 759 <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>
 760 </div><div class="extra"></div></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 2635 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2635">&#x27ad;</a></h3>
 761 <div class="dr-method"><p>Removes all drag event handlers from given element.
 762 </p>
 763 </div><div class="extra"></div></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 2566 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2566">&#x27ad;</a></h3>
 764 <div class="dr-method"><p>Removes event handlers for hover for the element.
 765 </p>
 766 <p class="header">Parameters
 767 </p>
 768 <dl class="dr-parameters"><dt class="dr-param">f_in</dt>
 769 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 770 <dd class="dr-description">handler for hover in</dd>
 771 <dt class="dr-param">f_out</dt>
 772 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 773 <dd class="dr-description">handler for hover out</dd>
 774 </dl>
 775 <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>
 776 </div><div class="extra"></div></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 2309 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2309">&#x27ad;</a></h3>
 777 <div class="dr-method"><p>Removes event handler for mousedown for the element.
 778 </p>
 779 <p class="header">Parameters
 780 </p>
 781 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 782 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 783 <dd class="dr-description">handler for the event</dd>
 784 </dl>
 785 <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>
 786 </div><div class="extra"></div></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 2328 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2328">&#x27ad;</a></h3>
 787 <div class="dr-method"><p>Removes event handler for mousemove for the element.
 788 </p>
 789 <p class="header">Parameters
 790 </p>
 791 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 792 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 793 <dd class="dr-description">handler for the event</dd>
 794 </dl>
 795 <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>
 796 </div><div class="extra"></div></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 2347 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2347">&#x27ad;</a></h3>
 797 <div class="dr-method"><p>Removes event handler for mouseout for the element.
 798 </p>
 799 <p class="header">Parameters
 800 </p>
 801 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 802 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 803 <dd class="dr-description">handler for the event</dd>
 804 </dl>
 805 <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>
 806 </div><div class="extra"></div></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 2366 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2366">&#x27ad;</a></h3>
 807 <div class="dr-method"><p>Removes event handler for mouseover for the element.
 808 </p>
 809 <p class="header">Parameters
 810 </p>
 811 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 812 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 813 <dd class="dr-description">handler for the event</dd>
 814 </dl>
 815 <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>
 816 </div><div class="extra"></div></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 2385 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2385">&#x27ad;</a></h3>
 817 <div class="dr-method"><p>Removes event handler for mouseup for the element.
 818 </p>
 819 <p class="header">Parameters
 820 </p>
 821 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 822 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 823 <dd class="dr-description">handler for the event</dd>
 824 </dl>
 825 <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>
 826 </div><div class="extra"></div></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 2461 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2461">&#x27ad;</a></h3>
 827 <div class="dr-method"><p>Removes event handler for touchcancel for the element.
 828 </p>
 829 <p class="header">Parameters
 830 </p>
 831 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 832 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 833 <dd class="dr-description">handler for the event</dd>
 834 </dl>
 835 <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>
 836 </div><div class="extra"></div></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 2442 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2442">&#x27ad;</a></h3>
 837 <div class="dr-method"><p>Removes event handler for touchend for the element.
 838 </p>
 839 <p class="header">Parameters
 840 </p>
 841 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 842 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 843 <dd class="dr-description">handler for the event</dd>
 844 </dl>
 845 <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>
 846 </div><div class="extra"></div></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 2423 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2423">&#x27ad;</a></h3>
 847 <div class="dr-method"><p>Removes event handler for touchmove for the element.
 848 </p>
 849 <p class="header">Parameters
 850 </p>
 851 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 852 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 853 <dd class="dr-description">handler for the event</dd>
 854 </dl>
 855 <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>
 856 </div><div class="extra"></div></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 2404 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2404">&#x27ad;</a></h3>
 857 <div class="dr-method"><p>Removes event handler for touchstart for the element.
 858 </p>
 859 <p class="header">Parameters
 860 </p>
 861 <dl class="dr-parameters"><dt class="dr-param">handler</dt>
 862 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
 863 <dd class="dr-description">handler for the event</dd>
 864 </dl>
 865 <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>
 866 </div><div class="extra"></div></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>
 867 <div class="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 1892 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1892">&#x27ad;</a></h3>
 868 <div class="dr-method"><p>Adds given matrix to existing one.
 869 </p>
 870 <p class="header">Parameters
 871 </p>
 872 <dl class="dr-parameters"><dt class="dr-param">a</dt>
 873 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 874 <dd class="dr-description">&#160;</dd>
 875 <dt class="dr-param">b</dt>
 876 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 877 <dd class="dr-description">&#160;</dd>
 878 <dt class="dr-param">c</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">d</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">e</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">f</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">matrix</dt>
 891 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
 892 <dd class="dr-description"><a href="#Matrix" class="dr-link">Matrix</a></dd>
 893 </dl>
 894 </div><div class="extra"></div></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 1937 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1937">&#x27ad;</a></h3>
 895 <div class="dr-method"><p>Returns copy of the matrix
 896 </p>
 897 <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>
 898 </div><div class="extra"></div></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 1925 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1925">&#x27ad;</a></h3>
 899 <div class="dr-method"><p>Returns inverted version of the matrix
 900 </p>
 901 <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>
 902 </div><div class="extra"></div></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 1979 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1979">&#x27ad;</a></h3>
 903 <div class="dr-method"><p>Rotates the matrix
 904 </p>
 905 <p class="header">Parameters
 906 </p>
 907 <dl class="dr-parameters"><dt class="dr-param">a</dt>
 908 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 909 <dd class="dr-description">&#160;</dd>
 910 <dt class="dr-param">x</dt>
 911 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 912 <dd class="dr-description">&#160;</dd>
 913 <dt class="dr-param">y</dt>
 914 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 915 <dd class="dr-description">&#160;</dd>
 916 </dl>
 917 </div><div class="extra"></div></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 1963 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1963">&#x27ad;</a></h3>
 918 <div class="dr-method"><p>Scales the matrix
 919 </p>
 920 <p class="header">Parameters
 921 </p>
 922 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 923 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 924 <dd class="dr-description">&#160;</dd>
 925 <dt class="dr-param optional">y</dt>
 926 <dd class="dr-optional">optional</dd>
 927 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 928 <dd class="dr-description">&#160;</dd>
 929 <dt class="dr-param optional">cx</dt>
 930 <dd class="dr-optional">optional</dd>
 931 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 932 <dd class="dr-description">&#160;</dd>
 933 <dt class="dr-param optional">cy</dt>
 934 <dd class="dr-optional">optional</dd>
 935 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 936 <dd class="dr-description">&#160;</dd>
 937 </dl>
 938 </div><div class="extra"></div></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 2052 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2052">&#x27ad;</a></h3>
 939 <div class="dr-method"><p>Splits matrix into primitive transformations
 940 </p>
 941 <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>
 942 <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>
 943 <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>
 944 <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>
 945 <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>
 946 <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>
 947 <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>
 948 <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>
 949 </ol>
 950 </div><div class="extra"></div></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 2094 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2094">&#x27ad;</a></h3>
 951 <div class="dr-method"><p>Return transform string that represents given matrix
 952 </p>
 953 <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>
 954 </div><div class="extra"></div></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 1949 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1949">&#x27ad;</a></h3>
 955 <div class="dr-method"><p>Translate the matrix
 956 </p>
 957 <p class="header">Parameters
 958 </p>
 959 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 960 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 961 <dd class="dr-description">&#160;</dd>
 962 <dt class="dr-param">y</dt>
 963 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 964 <dd class="dr-description">&#160;</dd>
 965 </dl>
 966 </div><div class="extra"></div></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 1998 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1998">&#x27ad;</a></h3>
 967 <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>
 968 </p>
 969 <p class="header">Parameters
 970 </p>
 971 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 972 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 973 <dd class="dr-description">&#160;</dd>
 974 <dt class="dr-param">y</dt>
 975 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 976 <dd class="dr-description">&#160;</dd>
 977 </dl>
 978 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">x</span></p>
 979 </div><div class="extra"></div></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 2011 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2011">&#x27ad;</a></h3>
 980 <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>
 981 </p>
 982 <p class="header">Parameters
 983 </p>
 984 <dl class="dr-parameters"><dt class="dr-param">x</dt>
 985 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 986 <dd class="dr-description">&#160;</dd>
 987 <dt class="dr-param">y</dt>
 988 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
 989 <dd class="dr-description">&#160;</dd>
 990 </dl>
 991 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">y</span></p>
 992 </div><div class="extra"></div></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>
 993 <div class="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 2884 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2884">&#x27ad;</a></h3>
 994 <div class="dr-property"><p>Points to the bottom element on the paper
 995 </p>
 996 </div><div class="extra"></div></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 2660 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2660">&#x27ad;</a></h3>
 997 <div class="dr-method"><p>Draws a circle.
 998 </p>
 999 <p class="header">Parameters
1000 </p>
1001 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1002 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1003 <dd class="dr-description">x coordinate of the centre</dd>
1004 <dt class="dr-param">y</dt>
1005 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1006 <dd class="dr-description">y coordinate of the centre</dd>
1007 <dt class="dr-param">r</dt>
1008 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1009 <dd class="dr-description">radius</dd>
1010 </dl>
1011 <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>
1012 <p class="header">Usage
1013 </p>
1014 <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>);
1015 </code></pre>
1016 </div><div class="extra"></div></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 1303 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1303">&#x27ad;</a></h3>
1017 <div class="dr-method"><p>Clears the paper, i.e. removes all the elements.
1018 </p>
1019 </div><div class="extra"></div></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 362 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L362">&#x27ad;</a></h3>
1020 <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
1021 as a function of some number you can do it easily with custom attributes:
1022 </p>
1023 <p class="header">Usage
1024 </p>
1025 <pre class="javascript code"><code>paper.customAttributes.hue<span class="s"> = </span><b>function</b> (num) {
1026     num<span class="s"> = </span>num<span class="s"> % </span><span class="d">1</span>;
1027     <b>return</b> {fill: <i>"hsb("</i><span class="s"> + </span>num<span class="s"> + </span><i>", <span class="d">.75</span>, <span class="d">1</span>)"</i>};
1028 };
1029 <span class="c">// Custom attribute “hue” will change fill</span>
1030 <span class="c">// to be given hue <b>with</b> fixed saturation and brightness.</span>
1031 <span class="c">// Now you can use it like <b>this</b>:</span>
1032 <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>});
1033 <span class="c">// or even like <b>this</b>:</span>
1034 c.animate({hue: <span class="d">1</span>}, <span class="d">1e3</span>);
1035
1036 <span class="c">// You could also create custom attribute</span>
1037 <span class="c">// <b>with</b> multiple parameters:</span>
1038 paper.customAttributes.hsb<span class="s"> = </span><b>function</b> (h, s, b) {
1039     <b>return</b> {fill: <i>"hsb("</i><span class="s"> + </span>[h, s, b].join(<i>","</i>)<span class="s"> + </span><i>")"</i>};
1040 };
1041 c.attr({hsb: <i>"<span class="d">.5</span> <span class="d">.8</span> <span class="d">1</span>"</i>});
1042 c.animate({hsb: <i>"<span class="d">1</span> <span class="d">0</span> <span class="d">.5</span>"</i>}, <span class="d">1e3</span>);
1043 </code></pre>
1044 </div><div class="extra"></div></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 2708 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2708">&#x27ad;</a></h3>
1045 <div class="dr-method"><p>Draws an ellipse.
1046 </p>
1047 <p class="header">Parameters
1048 </p>
1049 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1050 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1051 <dd class="dr-description">x coordinate of the centre</dd>
1052 <dt class="dr-param">y</dt>
1053 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1054 <dd class="dr-description">y coordinate of the centre</dd>
1055 <dt class="dr-param">rx</dt>
1056 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1057 <dd class="dr-description">horizontal radius</dd>
1058 <dt class="dr-param">ry</dt>
1059 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1060 <dd class="dr-description">vertical radius</dd>
1061 </dl>
1062 <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>
1063 <p class="header">Usage
1064 </p>
1065 <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>);
1066 </code></pre>
1067 </div><div class="extra"></div></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 2979 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2979">&#x27ad;</a></h3>
1068 <div class="dr-method"><p>Executes given function for each element on the paper
1069 </p>
1070 <p>If callback function returns <code>false</code> it will stop loop running.
1071 </p>
1072 <p class="header">Parameters
1073 </p>
1074 <dl class="dr-parameters"><dt class="dr-param">callback</dt>
1075 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1076 <dd class="dr-description">function to run</dd>
1077 <dt class="dr-param">thisArg</dt>
1078 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1079 <dd class="dr-description">context object for the callback</dd>
1080 </dl>
1081 <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>
1082 </div><div class="extra"></div></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 2955 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2955">&#x27ad;</a></h3>
1083 <div class="dr-method"><p>Returns you element by its internal ID.
1084 </p>
1085 <p class="header">Parameters
1086 </p>
1087 <dl class="dr-parameters"><dt class="dr-param">id</dt>
1088 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1089 <dd class="dr-description">id</dd>
1090 </dl>
1091 <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>
1092 </div><div class="extra"></div></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 2919 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2919">&#x27ad;</a></h3>
1093 <div class="dr-method"><p>Returns you topmost element under given point.
1094 </p>
1095 <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>
1096 <p class="header">Parameters
1097 </p>
1098 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1099 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1100 <dd class="dr-description">x coordinate from the top left corner of the window</dd>
1101 <dt class="dr-param">y</dt>
1102 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1103 <dd class="dr-description">y coordinate from the top left corner of the window</dd>
1104 </dl>
1105 <p class="header">Usage
1106 </p>
1107 <pre class="javascript code"><code>paper.getElementByPoint(mouseX, mouseY).attr({stroke: <i>"#f00"</i>});
1108 </code></pre>
1109 </div><div class="extra"></div></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 4329 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4329">&#x27ad;</a></h3>
1110 <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”.
1111 </p>
1112 <p class="header">Parameters
1113 </p>
1114 <dl class="dr-parameters"><dt class="dr-param">family</dt>
1115 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1116 <dd class="dr-description">font family name or any word from it</dd>
1117 <dt class="dr-param optional">weight</dt>
1118 <dd class="dr-optional">optional</dd>
1119 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1120 <dd class="dr-description">font weight</dd>
1121 <dt class="dr-param optional">style</dt>
1122 <dd class="dr-optional">optional</dd>
1123 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1124 <dd class="dr-description">font style</dd>
1125 <dt class="dr-param optional">stretch</dt>
1126 <dd class="dr-optional">optional</dd>
1127 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1128 <dd class="dr-description">font stretch</dd>
1129 </dl>
1130 <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>
1131 <p class="header">Usage
1132 </p>
1133 <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>);
1134 </code></pre>
1135 </div><div class="extra"></div></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 2754 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2754">&#x27ad;</a></h3>
1136 <div class="dr-method"><p>Embeds an image into the surface.
1137 </p>
1138 <p class="header">Parameters
1139 </p>
1140 <dl class="dr-parameters"><dt class="dr-param">src</dt>
1141 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1142 <dd class="dr-description">URI of the source image</dd>
1143 <dt class="dr-param">x</dt>
1144 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1145 <dd class="dr-description">x coordinate position</dd>
1146 <dt class="dr-param">y</dt>
1147 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1148 <dd class="dr-description">y coordinate position</dd>
1149 <dt class="dr-param">width</dt>
1150 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1151 <dd class="dr-description">width of the image</dd>
1152 <dt class="dr-param">height</dt>
1153 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1154 <dd class="dr-description">height of the image</dd>
1155 </dl>
1156 <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>
1157 <p class="header">Usage
1158 </p>
1159 <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>);
1160 </code></pre>
1161 </div><div class="extra"></div></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 2730 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2730">&#x27ad;</a></h3>
1162 <div class="dr-method"><p>Creates a path element by given path data string.
1163 </p>
1164 <p class="header">Parameters
1165 </p>
1166 <dl class="dr-parameters"><dt class="dr-param">pathString</dt>
1167 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1168 <dd class="dr-description">path data in SVG path string format.</dd>
1169 </dl>
1170 <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 “path”</span></p>
1171 Details of a path's data attribute's format are described in the <a href="http://www.w3.org/TR/SVG/paths.html#PathData">SVG specification</a>.
1172 <p class="header">Usage
1173 </p>
1174 <pre class="javascript code"><code><b>var</b> c<span class="s"> = </span>paper.path(<i>"M10 10L90 <span class="d">90</span>"</i>);
1175 <span class="c">// draw a diagonal line:</span>
1176 <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>
1177 </code></pre>
1178 </div><div class="extra"></div></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 4379 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4379">&#x27ad;</a></h3>
1179 <div class="dr-method"><p>Creates set of shapes to represent given font at given position with given size.
1180 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.
1181 </p>
1182 <p class="header">Parameters
1183 </p>
1184 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1185 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1186 <dd class="dr-description">x position of the text</dd>
1187 <dt class="dr-param">y</dt>
1188 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1189 <dd class="dr-description">y position of the text</dd>
1190 <dt class="dr-param">text</dt>
1191 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1192 <dd class="dr-description">text to print</dd>
1193 <dt class="dr-param">font</dt>
1194 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1195 <dd class="dr-description">font object, see <a href="#Paper.getFont" class="dr-link">Paper.getFont</a></dd>
1196 <dt class="dr-param optional">size</dt>
1197 <dd class="dr-optional">optional</dd>
1198 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1199 <dd class="dr-description">size of the font, default is <code>16</code></dd>
1200 <dt class="dr-param optional">origin</dt>
1201 <dd class="dr-optional">optional</dd>
1202 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1203 <dd class="dr-description">could be <code>"baseline"</code> or <code>"middle"</code>, default is <code>"middle"</code></dd>
1204 <dt class="dr-param optional">letter_spacing</dt>
1205 <dd class="dr-optional">optional</dd>
1206 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1207 <dd class="dr-description">number in range <code>-1..1</code>, default is <code>0</code></dd>
1208 </dl>
1209 <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>
1210 <p class="header">Usage
1211 </p>
1212 <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>});
1213 <span class="c">// following line will paint first letter <b>in</b> red</span>
1214 txt[<span class="d">0</span>].attr({fill: <i>"#f00"</i>});
1215 </code></pre>
1216 </div><div class="extra"></div></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 2891 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2891">&#x27ad;</a></h3>
1217 <div class="dr-property"><p>Points to the <a href="#Raphael" class="dr-link">Raphael</a> object/function
1218 </p>
1219 </div><div class="extra"></div></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 2686 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2686">&#x27ad;</a></h3>
1220 <div class="dr-method"><p></p>
1221 <p>Draws a rectangle.
1222 </p>
1223 <p class="header">Parameters
1224 </p>
1225 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1226 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1227 <dd class="dr-description">x coordinate of the top left corner</dd>
1228 <dt class="dr-param">y</dt>
1229 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1230 <dd class="dr-description">y coordinate of the top left corner</dd>
1231 <dt class="dr-param">width</dt>
1232 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1233 <dd class="dr-description">width</dd>
1234 <dt class="dr-param">height</dt>
1235 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1236 <dd class="dr-description">height</dd>
1237 <dt class="dr-param optional">r</dt>
1238 <dd class="dr-optional">optional</dd>
1239 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1240 <dd class="dr-description">radius for rounded corners, default is 0</dd>
1241 </dl>
1242 <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>
1243 <p class="header">Usage
1244 </p>
1245 <pre class="javascript code"><code><span class="c">// regular rectangle</span>
1246 <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>);
1247 <span class="c">// rectangle <b>with</b> rounded corners</span>
1248 <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>);
1249 </code></pre>
1250 </div><div class="extra"></div></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 1320 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1320">&#x27ad;</a></h3>
1251 <div class="dr-method"><p>Removes the paper from the DOM.
1252 </p>
1253 </div><div class="extra"></div></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 1280 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.svg.js#L1280">&#x27ad;</a></h3>
1254 <div class="dr-method"><p>Fixes the issue of Firefox and IE9 regarding subpixel rendering. If paper is dependant
1255 on other elements after reflow it could shift half pixel which cause for lines to lost their crispness.
1256 This method fixes the issue.
1257 </p>
1258 </div><div class="extra"></div></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 2116 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2116">&#x27ad;</a></h3>
1259 <div class="dr-method"><p>There is an inconvenient rendering bug in Safari (WebKit):
1260 sometimes the rendering should be forced.
1261 This method should help with dealing with this bug.
1262 </p>
1263 </div><div class="extra"></div></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 2797 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2797">&#x27ad;</a></h3>
1264 <div class="dr-method"><p>Creates array-like object to keep and operate several elements at once.
1265 Warning: it doesn’t create any elements for itself in the page, it just groups existing elements.
1266 Sets act as pseudo elements — all methods available to an element can be used on a set.
1267 </p>
1268 <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>
1269 <p class="header">Usage
1270 </p>
1271 <pre class="javascript code"><code><b>var</b> st<span class="s"> = </span>paper.set();
1272 st.push(
1273     paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">5</span>),
1274     paper.circle(<span class="d">30</span>, <span class="d">10</span>, <span class="d">5</span>)
1275 );
1276 st.attr({fill: <i>"red"</i>}); <span class="c">// changes the fill of both circles</span>
1277 </code></pre>
1278 </div><div class="extra"></div></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 2828 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2828">&#x27ad;</a></h3>
1279 <div class="dr-method"><p>See <a href="#Paper.setStart" class="dr-link">Paper.setStart</a>. This method finishes catching and returns resulting set.
1280 </p>
1281 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">set</span></p>
1282 </div><div class="extra"></div></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 2851 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2851">&#x27ad;</a></h3>
1283 <div class="dr-method"><p>If you need to change dimensions of the canvas call this method
1284 </p>
1285 <p class="header">Parameters
1286 </p>
1287 <dl class="dr-parameters"><dt class="dr-param">width</dt>
1288 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1289 <dd class="dr-description">new width of the canvas</dd>
1290 <dt class="dr-param">height</dt>
1291 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1292 <dd class="dr-description">new height of the canvas</dd>
1293 </dl>
1294 <p class="header">Usage
1295 </p>
1296 <pre class="javascript code"><code><b>var</b> st<span class="s"> = </span>paper.set();
1297 st.push(
1298     paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">5</span>),
1299     paper.circle(<span class="d">30</span>, <span class="d">10</span>, <span class="d">5</span>)
1300 );
1301 st.attr({fill: <i>"red"</i>});
1302 </code></pre>
1303 </div><div class="extra"></div></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 2817 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2817">&#x27ad;</a></h3>
1304 <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
1305 <a href="#Paper.setFinish" class="dr-link">Paper.setFinish</a> will be added to the set.
1306 </p>
1307 <p class="header">Usage
1308 </p>
1309 <pre class="javascript code"><code>paper.setStart();
1310 paper.circle(<span class="d">10</span>, <span class="d">10</span>, <span class="d">5</span>),
1311 paper.circle(<span class="d">30</span>, <span class="d">10</span>, <span class="d">5</span>)
1312 <b>var</b> st<span class="s"> = </span>paper.setFinish();
1313 st.attr({fill: <i>"red"</i>}); <span class="c">// changes the fill of both circles</span>
1314 </code></pre>
1315 </div><div class="extra"></div></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 2869 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2869">&#x27ad;</a></h3>
1316 <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
1317 specifying new boundaries.
1318 </p>
1319 <p class="header">Parameters
1320 </p>
1321 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1322 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1323 <dd class="dr-description">new x position, default is <code>0</code></dd>
1324 <dt class="dr-param">y</dt>
1325 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1326 <dd class="dr-description">new y position, default is <code>0</code></dd>
1327 <dt class="dr-param">w</dt>
1328 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1329 <dd class="dr-description">new width of the canvas</dd>
1330 <dt class="dr-param">h</dt>
1331 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1332 <dd class="dr-description">new height of the canvas</dd>
1333 <dt class="dr-param">fit</dt>
1334 <dd class="dr-type"><em class="dr-type-boolean">boolean</em></dd>
1335 <dd class="dr-description"><code>true</code> if you want graphics to fit into new boundary box</dd>
1336 </dl>
1337 </div><div class="extra"></div></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 2775 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2775">&#x27ad;</a></h3>
1338 <div class="dr-method"><p>Draws a text string. If you need line breaks, put “\n” in the string.
1339 </p>
1340 <p class="header">Parameters
1341 </p>
1342 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1343 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1344 <dd class="dr-description">x coordinate position</dd>
1345 <dt class="dr-param">y</dt>
1346 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1347 <dd class="dr-description">y coordinate position</dd>
1348 <dt class="dr-param">text</dt>
1349 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1350 <dd class="dr-description">The text string to draw</dd>
1351 </dl>
1352 <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>
1353 <p class="header">Usage
1354 </p>
1355 <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>);
1356 </code></pre>
1357 </div><div class="extra"></div></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 2878 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2878">&#x27ad;</a></h3>
1358 <div class="dr-property"><p>Points to the topmost element on the paper
1359 </p>
1360 </div><div class="extra"></div></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/2.0/raphael.core.js#L59">&#x27ad;</a></h2>
1361 <div class="dr-method"><p>Creates a canvas object on which to draw.
1362 You must do this first, as all future calls to drawing methods
1363 from this instance will be bound to this canvas.
1364 </p>
1365 <p class="header">Parameters
1366 </p>
1367 <dl class="dr-parameters"><dt class="dr-param">container</dt>
1368 <dd class="dr-type"><em class="dr-type-HTMLElement">HTMLElement</em> <em class="dr-type-string">string</em></dd>
1369 <dd class="dr-description">DOM element or its ID which is going to be a parent for drawing surface</dd>
1370 <dt class="dr-param">width</dt>
1371 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1372 <dd class="dr-description">&#160;</dd>
1373 <dt class="dr-param">height</dt>
1374 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1375 <dd class="dr-description">&#160;</dd>
1376 <dt class="dr-param optional">callback</dt>
1377 <dd class="dr-optional">optional</dd>
1378 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1379 <dd class="dr-description">callback function which is going to be executed in the context of newly created paper</dd>
1380 </dl>
1381 <p>or
1382 </p>
1383 <dl class="dr-parameters"><dt class="dr-param">x</dt>
1384 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1385 <dd class="dr-description">&#160;</dd>
1386 <dt class="dr-param">y</dt>
1387 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1388 <dd class="dr-description">&#160;</dd>
1389 <dt class="dr-param">width</dt>
1390 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1391 <dd class="dr-description">&#160;</dd>
1392 <dt class="dr-param">height</dt>
1393 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1394 <dd class="dr-description">&#160;</dd>
1395 <dt class="dr-param optional">callback</dt>
1396 <dd class="dr-optional">optional</dd>
1397 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1398 <dd class="dr-description">callback function which is going to be executed in the context of newly created paper</dd>
1399 </dl>
1400 <p>or
1401 </p>
1402 <dl class="dr-parameters"><dt class="dr-param">all</dt>
1403 <dd class="dr-type"><em class="dr-type-array">array</em></dd>
1404 <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>
1405 <dt class="dr-param optional">callback</dt>
1406 <dd class="dr-optional">optional</dd>
1407 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1408 <dd class="dr-description">callback function which is going to be executed in the context of newly created paper</dd>
1409 </dl>
1410 <p>or
1411 </p>
1412 <dl class="dr-parameters"><dt class="dr-param">onReadyCallback</dt>
1413 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1414 <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>
1415 </dl>
1416 <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>
1417 <p class="header">Usage
1418 </p>
1419 <pre class="javascript code"><code><span class="c">// Each of the following examples create a canvas</span>
1420 <span class="c">// that is 320px wide by 200px high.</span>
1421 <span class="c">// Canvas is created at the viewport’s <span class="d">10</span>,<span class="d">50</span> coordinate.</span>
1422 <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>);
1423 <span class="c">// Canvas is created at the top left corner of the #notepad element</span>
1424 <span class="c">// (or its top right corner <b>in</b> dir=<i>"rtl"</i> elements)</span>
1425 <b>var</b> paper<span class="s"> = </span>Raphael(document.getElementById(<i>"notepad"</i>), <span class="d">320</span>, <span class="d">200</span>);
1426 <span class="c">// Same as above</span>
1427 <b>var</b> paper<span class="s"> = </span>Raphael(<i>"notepad"</i>, <span class="d">320</span>, <span class="d">200</span>);
1428 <span class="c">// Image dump</span>
1429 <b>var</b> set<span class="s"> = </span>Raphael([<i>"notepad"</i>, <span class="d">320</span>, <span class="d">200</span>, {
1430     type: <i>"rect"</i>,
1431     x: <span class="d">10</span>,
1432     y: <span class="d">10</span>,
1433     width: <span class="d">25</span>,
1434     height: <span class="d">25</span>,
1435     stroke: <i>"#f00"</i>
1436 }, {
1437     type: <i>"text"</i>,
1438     x: <span class="d">30</span>,
1439     y: <span class="d">40</span>,
1440     text: <i>"Dump"</i>
1441 }]);
1442 </code></pre>
1443 </div><div class="extra"></div></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 403 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L403">&#x27ad;</a></h3>
1444 <div class="dr-method"><p>Returns angle between two or three points
1445 </p>
1446 <p class="header">Parameters
1447 </p>
1448 <dl class="dr-parameters"><dt class="dr-param">x1</dt>
1449 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1450 <dd class="dr-description">x coord of first point</dd>
1451 <dt class="dr-param">y1</dt>
1452 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1453 <dd class="dr-description">y coord of first point</dd>
1454 <dt class="dr-param">x2</dt>
1455 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1456 <dd class="dr-description">x coord of second point</dd>
1457 <dt class="dr-param">y2</dt>
1458 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1459 <dd class="dr-description">y coord of second point</dd>
1460 <dt class="dr-param optional">x3</dt>
1461 <dd class="dr-optional">optional</dd>
1462 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1463 <dd class="dr-description">x coord of third point</dd>
1464 <dt class="dr-param optional">y3</dt>
1465 <dd class="dr-optional">optional</dd>
1466 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1467 <dd class="dr-description">y coord of third point</dd>
1468 </dl>
1469 <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>
1470 </div><div class="extra"></div></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 3848 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3848">&#x27ad;</a></h3>
1471 <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.
1472 See also <a href="#Animation.delay" class="dr-link">Animation.delay</a> and <a href="#Animation.repeat" class="dr-link">Animation.repeat</a> methods.
1473 </p>
1474 <p class="header">Parameters
1475 </p>
1476 <dl class="dr-parameters"><dt class="dr-param">params</dt>
1477 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1478 <dd class="dr-description">final attributes for the element, see also <a href="#Element.attr" class="dr-link">Element.attr</a></dd>
1479 <dt class="dr-param">ms</dt>
1480 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1481 <dd class="dr-description">number of milliseconds for animation to run</dd>
1482 <dt class="dr-param optional">easing</dt>
1483 <dd class="dr-optional">optional</dd>
1484 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1485 <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>
1486 <dt class="dr-param optional">callback</dt>
1487 <dd class="dr-optional">optional</dd>
1488 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
1489 <dd class="dr-description">callback function. Will be called at the end of animation.</dd>
1490 </dl>
1491 <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>
1492 </div><div class="extra"></div></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 596 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L596">&#x27ad;</a></h3>
1493 <div class="dr-method"><p>Parses the color string and returns object with all values for the given color.
1494 </p>
1495 <p class="header">Parameters
1496 </p>
1497 <dl class="dr-parameters"><dt class="dr-param">clr</dt>
1498 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1499 <dd class="dr-description">color string in one of the supported formats (see <a href="#Raphael.getRGB" class="dr-link">Raphael.getRGB</a>)</dd>
1500 </dl>
1501 <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>
1502 <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>
1503 <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>
1504 <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>
1505 <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>
1506 <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>
1507 <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>
1508 <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>
1509 <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>
1510 <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>
1511 </ol></li><li>}</li></ol>
1512 </div><div class="extra"></div></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 436 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L436">&#x27ad;</a></h3>
1513 <div class="dr-method"><p>Transform angle to degrees
1514 </p>
1515 <p class="header">Parameters
1516 </p>
1517 <dl class="dr-parameters"><dt class="dr-param">deg</dt>
1518 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1519 <dd class="dr-description">angle in radians</dd>
1520 </dl>
1521 <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>
1522 </div><div class="extra"></div></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 3300 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3300">&#x27ad;</a></h3>
1523 <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:
1524 </p>
1525 <ul>
1526     <li>“linear”</li>
1527     <li>“&lt;” or “easeIn” or “ease-in”</li>
1528     <li>“>” or “easeOut” or “ease-out”</li>
1529     <li>“&lt;>” or “easeInOut” or “ease-in-out”</li>
1530     <li>“backIn” or “back-in”</li>
1531     <li>“backOut” or “back-out”</li>
1532     <li>“elastic”</li>
1533     <li>“bounce”</li>
1534 </ul>
1535 <p>See also <a href="http://raphaeljs.com/easing.html">Easing demo</a>.</p>
1536 </div><div class="extra"></div></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 2252 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L2252">&#x27ad;</a></h3>
1537 <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
1538 want to wrap some common transformation or attributes in one method. In difference to canvas methods,
1539 you can redefine element method at any time. Expending element methods wouldn’t affect set.
1540 </p>
1541 <p class="header">Usage
1542 </p>
1543 <pre class="javascript code"><code>Raphael.el.red<span class="s"> = </span><b>function</b> () {
1544     <b>this</b>.attr({fill: <i>"#f00"</i>});
1545 };
1546 <span class="c">// then use it</span>
1547 paper.circle(<span class="d">100</span>, <span class="d">100</span>, <span class="d">20</span>).red();
1548 </code></pre>
1549 </div><div class="extra"></div></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 1109 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1109">&#x27ad;</a></h3>
1550 <div class="dr-method"><p>Utility method
1551 Find dot coordinates on the given cubic bezier curve at the given t.
1552 </p>
1553 <p class="header">Parameters
1554 </p>
1555 <dl class="dr-parameters"><dt class="dr-param">p1x</dt>
1556 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1557 <dd class="dr-description">x of the first point of the curve</dd>
1558 <dt class="dr-param">p1y</dt>
1559 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1560 <dd class="dr-description">y of the first point of the curve</dd>
1561 <dt class="dr-param">c1x</dt>
1562 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1563 <dd class="dr-description">x of the first anchor of the curve</dd>
1564 <dt class="dr-param">c1y</dt>
1565 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1566 <dd class="dr-description">y of the first anchor of the curve</dd>
1567 <dt class="dr-param">c2x</dt>
1568 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1569 <dd class="dr-description">x of the second anchor of the curve</dd>
1570 <dt class="dr-param">c2y</dt>
1571 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1572 <dd class="dr-description">y of the second anchor of the curve</dd>
1573 <dt class="dr-param">p2x</dt>
1574 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1575 <dd class="dr-description">x of the second point of the curve</dd>
1576 <dt class="dr-param">p2y</dt>
1577 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1578 <dd class="dr-description">y of the second point of the curve</dd>
1579 <dt class="dr-param">t</dt>
1580 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1581 <dd class="dr-description">position on the curve (0..1)</dd>
1582 </dl>
1583 <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>
1584 <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>
1585 <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>
1586 <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>
1587 <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>
1588 </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>
1589 <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>
1590 </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>
1591 <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>
1592 </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>
1593 <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>
1594 </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>
1595 </ol></li><li>}</li></ol>
1596 </div><div class="extra"></div></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 335 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L335">&#x27ad;</a></h3>
1597 <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,
1598 you can create your own pie chart function and ship it as a Raphaël plugin. To do this
1599 you need to extend the <code>Raphael.fn</code> object. Please note that you can create your own namespaces
1600 inside the <code>fn</code> object — methods will be run in the context of canvas anyway. You should alter
1601 the <code>fn</code> object before a Raphaël instance is created, otherwise it will take no effect.
1602 </p>
1603 <p class="header">Usage
1604 </p>
1605 <pre class="javascript code"><code>Raphael.fn.arrow<span class="s"> = </span><b>function</b> (x1, y1, x2, y2, size) {
1606     <b>return</b> <b>this</b>.path( ... );
1607 };
1608 <span class="c">// or create namespace</span>
1609 Raphael.fn.mystuff<span class="s"> = </span>{
1610     arrow: <b>function</b> () {…},
1611     star: <b>function</b> () {…},
1612     <span class="c">// etc…</span>
1613 };
1614 <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>);
1615 <span class="c">// then use it</span>
1616 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>});
1617 paper.mystuff.arrow();
1618 paper.mystuff.star();
1619 </code></pre>
1620 </div><div class="extra"></div></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 4427 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4427">&#x27ad;</a></h3>
1621 <div class="dr-method"><p>Simple format function. Replaces construction of type “<code>{&lt;number>}</code>” to the corresponding argument.
1622 </p>
1623 <p class="header">Parameters
1624 </p>
1625 <dl class="dr-parameters"><dt class="dr-param">token</dt>
1626 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1627 <dd class="dr-description">string to format</dd>
1628 <dt class="dr-param">…</dt>
1629 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1630 <dd class="dr-description">rest of arguments will be treated as parameters for replacement</dd>
1631 </dl>
1632 <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>
1633 <p class="header">Usage
1634 </p>
1635 <pre class="javascript code"><code><b>var</b> x<span class="s"> = </span><span class="d">10</span>,
1636     y<span class="s"> = </span><span class="d">20</span>,
1637     width<span class="s"> = </span><span class="d">40</span>,
1638     height<span class="s"> = </span><span class="d">50</span>;
1639 <span class="c">// <b>this</b> will draw a rectangular shape equivalent to <i>"M10,20h40v50h-40z"</i></span>
1640 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));
1641 </code></pre>
1642 </div><div class="extra"></div></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 4457 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4457">&#x27ad;</a></h3>
1643 <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.
1644 </p>
1645 <p class="header">Parameters
1646 </p>
1647 <dl class="dr-parameters"><dt class="dr-param">token</dt>
1648 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1649 <dd class="dr-description">string to format</dd>
1650 <dt class="dr-param">json</dt>
1651 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1652 <dd class="dr-description">object which properties will be used as a replacement</dd>
1653 </dl>
1654 <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>
1655 <p class="header">Usage
1656 </p>
1657 <pre class="javascript code"><code><span class="c">// <b>this</b> will draw a rectangular shape equivalent to <i>"M10,20h40v50h-40z"</i></span>
1658 paper.path(Raphael.format(<i>"M{x},{y}h{dim.width}v{dim.height}h{dim['negative width']}z"</i>, {
1659     x: <span class="d">10</span>,
1660     y: <span class="d">20</span>,
1661     dim: {
1662         width: <span class="d">40</span>,
1663         height: <span class="d">50</span>,
1664         <i>"negative width"</i>: -<span class="d">40</span>
1665     }
1666 }));
1667 </code></pre>
1668 </div><div class="extra"></div></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 972 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L972">&#x27ad;</a></h3>
1669 <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>
1670 </p>
1671 <p class="header">Parameters
1672 </p>
1673 <dl class="dr-parameters"><dt class="dr-param optional">value</dt>
1674 <dd class="dr-optional">optional</dd>
1675 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1676 <dd class="dr-description">brightness, default is <code>0.75</code></dd>
1677 </dl>
1678 <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>
1679 </div><div class="extra"></div></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 989 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L989">&#x27ad;</a></h4>
1680 <div class="dr-method"><p>Resets spectrum position for <a href="#Raphael.getColor" class="dr-link">Raphael.getColor</a> back to red.
1681 </p>
1682 </div><div class="extra"></div></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 3209 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3209">&#x27ad;</a></h3>
1683 <div class="dr-method"><p>Return coordinates of the point located at the given length on the given path.
1684 </p>
1685 <p class="header">Parameters
1686 </p>
1687 <dl class="dr-parameters"><dt class="dr-param">path</dt>
1688 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1689 <dd class="dr-description">SVG path string</dd>
1690 <dt class="dr-param">length</dt>
1691 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1692 <dd class="dr-description">&#160;</dd>
1693 </dl>
1694 <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>
1695 <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>
1696 <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>
1697 <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>
1698 </ol></li><li>}</li></ol>
1699 </div><div class="extra"></div></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 850 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L850">&#x27ad;</a></h3>
1700 <div class="dr-method"><p>Parses colour string as RGB object
1701 </p>
1702 <p class="header">Parameters
1703 </p>
1704 <dl class="dr-parameters"><dt class="dr-param">colour</dt>
1705 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1706 <dd class="dr-description">colour string in one of formats:</dd>
1707 </dl>
1708 <ul>
1709     <li>Colour name (“<code>red</code>”, “<code>green</code>”, “<code>cornflowerblue</code>”, etc)</li>
1710     <li>#••• — shortened HTML colour: (“<code>#000</code>”, “<code>#fc0</code>”, etc)</li>
1711     <li>#•••••• — full length HTML colour: (“<code>#000000</code>”, “<code>#bd2300</code>”)</li>
1712     <li>rgb(•••, •••, •••) — red, green and blue channels’ values: (“<code>rgb(200,&nbsp;100,&nbsp;0)</code>”)</li>
1713     <li>rgb(•••%, •••%, •••%) — same as above, but in %: (“<code>rgb(100%,&nbsp;175%,&nbsp;0%)</code>”)</li>
1714     <li>hsb(•••, •••, •••) — hue, saturation and brightness values: (“<code>hsb(0.5,&nbsp;0.25,&nbsp;1)</code>”)</li>
1715     <li>hsb(•••%, •••%, •••%) — same as above, but in %</li>
1716     <li>hsl(•••, •••, •••) — same as hsb</li>
1717     <li>hsl(•••%, •••%, •••%) — same as hsb</li>
1718 </ul>
1719 <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>
1720 <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>
1721 <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>
1722 <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>
1723 <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>
1724 <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>
1725 </ol></li><li>}</li></ol>
1726 </div><div class="extra"></div></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 3224 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3224">&#x27ad;</a></h3>
1727 <div class="dr-method"><p>Return subpath of a given path from given length to given length.
1728 </p>
1729 <p class="header">Parameters
1730 </p>
1731 <dl class="dr-parameters"><dt class="dr-param">path</dt>
1732 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1733 <dd class="dr-description">SVG path string</dd>
1734 <dt class="dr-param">from</dt>
1735 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1736 <dd class="dr-description">position of the start of the segment</dd>
1737 <dt class="dr-param">to</dt>
1738 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1739 <dd class="dr-description">position of the end of the segment</dd>
1740 </dl>
1741 <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>
1742 </div><div class="extra"></div></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 3190 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L3190">&#x27ad;</a></h3>
1743 <div class="dr-method"><p>Returns length of the given path in pixels.
1744 </p>
1745 <p class="header">Parameters
1746 </p>
1747 <dl class="dr-parameters"><dt class="dr-param">path</dt>
1748 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1749 <dd class="dr-description">SVG path string.</dd>
1750 </dl>
1751 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-number">number</em> <span class="dr-description">length.</span></p>
1752 </div><div class="extra"></div></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 932 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L932">&#x27ad;</a></h3>
1753 <div class="dr-method"><p>Converts HSB values to hex representation of the colour.
1754 </p>
1755 <p class="header">Parameters
1756 </p>
1757 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1758 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1759 <dd class="dr-description">hue</dd>
1760 <dt class="dr-param">s</dt>
1761 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1762 <dd class="dr-description">saturation</dd>
1763 <dt class="dr-param">b</dt>
1764 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1765 <dd class="dr-description">value or brightness</dd>
1766 </dl>
1767 <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>
1768 </div><div class="extra"></div></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 646 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L646">&#x27ad;</a></h3>
1769 <div class="dr-method"><p>Converts HSB values to RGB object.
1770 </p>
1771 <p class="header">Parameters
1772 </p>
1773 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1774 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1775 <dd class="dr-description">hue</dd>
1776 <dt class="dr-param">s</dt>
1777 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1778 <dd class="dr-description">saturation</dd>
1779 <dt class="dr-param">v</dt>
1780 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1781 <dd class="dr-description">value or brightness</dd>
1782 </dl>
1783 <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>
1784 <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>
1785 <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>
1786 <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>
1787 <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>
1788 </ol></li><li>}</li></ol>
1789 </div><div class="extra"></div></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 946 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L946">&#x27ad;</a></h3>
1790 <div class="dr-method"><p>Converts HSL values to hex representation of the colour.
1791 </p>
1792 <p class="header">Parameters
1793 </p>
1794 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1795 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1796 <dd class="dr-description">hue</dd>
1797 <dt class="dr-param">s</dt>
1798 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1799 <dd class="dr-description">saturation</dd>
1800 <dt class="dr-param">l</dt>
1801 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1802 <dd class="dr-description">luminosity</dd>
1803 </dl>
1804 <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>
1805 </div><div class="extra"></div></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 683 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L683">&#x27ad;</a></h3>
1806 <div class="dr-method"><p>Converts HSL values to RGB object.
1807 </p>
1808 <p class="header">Parameters
1809 </p>
1810 <dl class="dr-parameters"><dt class="dr-param">h</dt>
1811 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1812 <dd class="dr-description">hue</dd>
1813 <dt class="dr-param">s</dt>
1814 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1815 <dd class="dr-description">saturation</dd>
1816 <dt class="dr-param">l</dt>
1817 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1818 <dd class="dr-description">luminosity</dd>
1819 </dl>
1820 <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>
1821 <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>
1822 <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>
1823 <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>
1824 <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>
1825 </ol></li><li>}</li></ol>
1826 </div><div class="extra"></div></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 375 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L375">&#x27ad;</a></h3>
1827 <div class="dr-method"><p>Handfull replacement for <code>typeof</code> operator.
1828 </p>
1829 <p class="header">Parameters
1830 </p>
1831 <dl class="dr-parameters"><dt class="dr-param">o</dt>
1832 <dd class="dr-type"><em class="dr-type-…">…</em></dd>
1833 <dd class="dr-description">any object or primitive</dd>
1834 <dt class="dr-param">type</dt>
1835 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
1836 <dd class="dr-description">name of the type, i.e. “string”, “function”, “number”, etc.</dd>
1837 </dl>
1838 <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>
1839 </div><div class="extra"></div></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 1856 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1856">&#x27ad;</a></h3>
1840 <div class="dr-method"><p>Utility method
1841 Returns matrix based on given parameters.
1842 </p>
1843 <p class="header">Parameters
1844 </p>
1845 <dl class="dr-parameters"><dt class="dr-param">a</dt>
1846 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1847 <dd class="dr-description">&#160;</dd>
1848 <dt class="dr-param">b</dt>
1849 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1850 <dd class="dr-description">&#160;</dd>
1851 <dt class="dr-param">c</dt>
1852 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1853 <dd class="dr-description">&#160;</dd>
1854 <dt class="dr-param">d</dt>
1855 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1856 <dd class="dr-description">&#160;</dd>
1857 <dt class="dr-param">e</dt>
1858 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1859 <dd class="dr-description">&#160;</dd>
1860 <dt class="dr-param">f</dt>
1861 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1862 <dd class="dr-description">&#160;</dd>
1863 </dl>
1864 <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>
1865 </div><div class="extra"></div></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 4494 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4494">&#x27ad;</a></h3>
1866 <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.
1867 Beware, that in this case plugins could stop working, because they are depending on global variable existance.
1868 </p>
1869 <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>
1870 <p class="header">Usage
1871 </p>
1872 <pre class="javascript code"><code>(<b>function</b> (local_raphael) {
1873     <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>);
1874     …
1875 })(Raphael.ninja());
1876 </code></pre>
1877 </div><div class="extra"></div></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 1004 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1004">&#x27ad;</a></h3>
1878 <div class="dr-method"><p>Utility method
1879 Parses given path string into an array of arrays of path segments.
1880 </p>
1881 <p class="header">Parameters
1882 </p>
1883 <dl class="dr-parameters"><dt class="dr-param">pathString</dt>
1884 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1885 <dd class="dr-description">path string or array of segments (in the last case it will be returned straight away)</dd>
1886 </dl>
1887 <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>
1888 </div><div class="extra"></div></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 1047 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1047">&#x27ad;</a></h3>
1889 <div class="dr-method"><p>Utility method
1890 Parses given path string into an array of transformations.
1891 </p>
1892 <p class="header">Parameters
1893 </p>
1894 <dl class="dr-parameters"><dt class="dr-param">TString</dt>
1895 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1896 <dd class="dr-description">transform string or array of transformations (in the last case it will be returned straight away)</dd>
1897 </dl>
1898 <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>
1899 </div><div class="extra"></div></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 1839 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1839">&#x27ad;</a></h3>
1900 <div class="dr-method"><p>Utility method
1901 Converts path to a new path where all segments are cubic bezier curves.
1902 </p>
1903 <p class="header">Parameters
1904 </p>
1905 <dl class="dr-parameters"><dt class="dr-param">pathString</dt>
1906 <dd class="dr-type"><em class="dr-type-string">string</em> <em class="dr-type-array">array</em></dd>
1907 <dd class="dr-description">path string or array of segments</dd>
1908 </dl>
1909 <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>
1910 </div><div class="extra"></div></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 1826 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L1826">&#x27ad;</a></h3>
1911 <div class="dr-method"><p>Utility method
1912 Converts path to relative form
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</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="extra"></div></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 424 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L424">&#x27ad;</a></h3>
1922 <div class="dr-method"><p>Transform angle to radians
1923 </p>
1924 <p class="header">Parameters
1925 </p>
1926 <dl class="dr-parameters"><dt class="dr-param">deg</dt>
1927 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1928 <dd class="dr-description">angle in degrees</dd>
1929 </dl>
1930 <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>
1931 </div><div class="extra"></div></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 4274 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4274">&#x27ad;</a></h3>
1932 <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.
1933 Returns original parameter, so it could be used with chaining.
1934 </p>
1935 <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>
1936 <p class="header">Parameters
1937 </p>
1938 <dl class="dr-parameters"><dt class="dr-param">font</dt>
1939 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
1940 <dd class="dr-description">the font to register</dd>
1941 </dl>
1942 <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>
1943 <p class="header">Usage
1944 </p>
1945 <pre class="javascript code"><code>Cufon.registerFont(Raphael.registerFont({…}));
1946 </code></pre>
1947 </div><div class="extra"></div></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 960 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L960">&#x27ad;</a></h3>
1948 <div class="dr-method"><p>Converts RGB values to hex representation of the colour.
1949 </p>
1950 <p class="header">Parameters
1951 </p>
1952 <dl class="dr-parameters"><dt class="dr-param">r</dt>
1953 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1954 <dd class="dr-description">red</dd>
1955 <dt class="dr-param">g</dt>
1956 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1957 <dd class="dr-description">green</dd>
1958 <dt class="dr-param">b</dt>
1959 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1960 <dd class="dr-description">blue</dd>
1961 </dl>
1962 <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>
1963 </div><div class="extra"></div></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 723 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L723">&#x27ad;</a></h3>
1964 <div class="dr-method"><p>Converts RGB values to HSB object.
1965 </p>
1966 <p class="header">Parameters
1967 </p>
1968 <dl class="dr-parameters"><dt class="dr-param">r</dt>
1969 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1970 <dd class="dr-description">red</dd>
1971 <dt class="dr-param">g</dt>
1972 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1973 <dd class="dr-description">green</dd>
1974 <dt class="dr-param">b</dt>
1975 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1976 <dd class="dr-description">blue</dd>
1977 </dl>
1978 <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>
1979 <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>
1980 <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>
1981 <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>
1982 </ol></li><li>}</li></ol>
1983 </div><div class="extra"></div></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 757 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L757">&#x27ad;</a></h3>
1984 <div class="dr-method"><p>Converts RGB values to HSL object.
1985 </p>
1986 <p class="header">Parameters
1987 </p>
1988 <dl class="dr-parameters"><dt class="dr-param">r</dt>
1989 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1990 <dd class="dr-description">red</dd>
1991 <dt class="dr-param">g</dt>
1992 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1993 <dd class="dr-description">green</dd>
1994 <dt class="dr-param">b</dt>
1995 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
1996 <dd class="dr-description">blue</dd>
1997 </dl>
1998 <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>
1999 <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>
2000 <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>
2001 <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>
2002 </ol></li><li>}</li></ol>
2003 </div><div class="extra"></div></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 488 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L488">&#x27ad;</a></h3>
2004 <div class="dr-method"><p>Used when you need to draw in <code>&lt;iframe></code>. Switched window to the iframe one.
2005 </p>
2006 <p class="header">Parameters
2007 </p>
2008 <dl class="dr-parameters"><dt class="dr-param">newwin</dt>
2009 <dd class="dr-type"><em class="dr-type-window">window</em></dd>
2010 <dd class="dr-description">new window object</dd>
2011 </dl>
2012 </div><div class="extra"></div></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 450 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L450">&#x27ad;</a></h3>
2013 <div class="dr-method"><p>Snaps given value to given grid.
2014 </p>
2015 <p class="header">Parameters
2016 </p>
2017 <dl class="dr-parameters"><dt class="dr-param">values</dt>
2018 <dd class="dr-type"><em class="dr-type-array">array</em> <em class="dr-type-number">number</em></dd>
2019 <dd class="dr-description">given array of values or step of the grid</dd>
2020 <dt class="dr-param">value</dt>
2021 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2022 <dd class="dr-description">value to adjust</dd>
2023 <dt class="dr-param optional">tolerance</dt>
2024 <dd class="dr-optional">optional</dd>
2025 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2026 <dd class="dr-description">tolerance for snapping. Default is <code>10</code>.</dd>
2027 </dl>
2028 <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>
2029 </div><div class="extra"></div></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 4518 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4518">&#x27ad;</a></h3>
2030 <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
2031 you added, so you will be able to call the same method on sets too.
2032 See also <a href="#Raphael.el" class="dr-link">Raphael.el</a>.
2033 </p>
2034 <p class="header">Usage
2035 </p>
2036 <pre class="javascript code"><code>Raphael.el.red<span class="s"> = </span><b>function</b> () {
2037     <b>this</b>.attr({fill: <i>"#f00"</i>});
2038 };
2039 Raphael.st.red<span class="s"> = </span><b>function</b> () {
2040     <b>this</b>.forEach(<b>function</b> () {
2041         <b>this</b>.red();
2042     });
2043 };
2044 <span class="c">// then use it</span>
2045 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();
2046 </code></pre>
2047 </div><div class="extra"></div></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 302 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L302">&#x27ad;</a></h3>
2048 <div class="dr-property"><em class="dr-type dr-type-boolean">boolean</em><p><code>true</code> if browser supports SVG.
2049 </p>
2050 </div><div class="extra"></div></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 284 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L284">&#x27ad;</a></h3>
2051 <div class="dr-property"><em class="dr-type dr-type-string">string</em><p>Can be “SVG”, “VML” or empty, depending on browser support.
2052 </p>
2053 </div><div class="extra"></div></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 308 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L308">&#x27ad;</a></h3>
2054 <div class="dr-property"><em class="dr-type dr-type-boolean">boolean</em><p><code>true</code> if browser supports VML.
2055 </p>
2056 </div><div class="extra"></div></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>
2057 <div class="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 4133 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4133">&#x27ad;</a></h3>
2058 <div class="dr-method"><p>Removeds all elements from the set
2059 </p>
2060 </div><div class="extra"></div></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 4188 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4188">&#x27ad;</a></h3>
2061 <div class="dr-method"><p>Removes given element from the set
2062 </p>
2063 <p class="header">Parameters
2064 </p>
2065 <dl class="dr-parameters"><dt class="dr-param">element</dt>
2066 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2067 <dd class="dr-description">element to remove</dd>
2068 </dl>
2069 <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>
2070 </div><div class="extra"></div></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 4097 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4097">&#x27ad;</a></h3>
2071 <div class="dr-method"><p>Executes given function for each element in the set.
2072 </p>
2073 <p>If function returns <code>false</code> it will stop loop running.
2074 </p>
2075 <p class="header">Parameters
2076 </p>
2077 <dl class="dr-parameters"><dt class="dr-param">callback</dt>
2078 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
2079 <dd class="dr-description">function to run</dd>
2080 <dt class="dr-param">thisArg</dt>
2081 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2082 <dd class="dr-description">context object for the callback</dd>
2083 </dl>
2084 <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>
2085 </div><div class="extra"></div></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 4079 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4079">&#x27ad;</a></h3>
2086 <div class="dr-method"><p>Removes last element and returns it.
2087 </p>
2088 <p class="dr-returns"><strong class="dr-title">Returns:</strong> <em class="dr-type-object">object</em> <span class="dr-description">element</span></p>
2089 </div><div class="extra"></div></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 4059 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4059">&#x27ad;</a></h3>
2090 <div class="dr-method"><p>Adds each argument to the current set.
2091 </p>
2092 <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>
2093 </div><div class="extra"></div></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 4151 in the source" href="https://github.com/DmitryBaranovskiy/raphael/blob/2.0/raphael.core.js#L4151">&#x27ad;</a></h3>
2094 <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">index</dt>
2099 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2100 <dd class="dr-description">position of the deletion</dd>
2101 <dt class="dr-param">count</dt>
2102 <dd class="dr-type"><em class="dr-type-number">number</em></dd>
2103 <dd class="dr-description">number of element to remove</dd>
2104 <dt class="dr-param optional">insertion…</dt>
2105 <dd class="dr-optional">optional</dd>
2106 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2107 <dd class="dr-description">elements to insert</dd>
2108 </dl>
2109 <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>
2110 </div><div class="extra"></div></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>
2111 <div class="dr-method"><p>Fires event with given <code>name</code>, given scope and other parameters.
2112 </p>
2113 <p class="header">Arguments
2114 </p>
2115 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2116 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2117 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated</dd>
2118 <dt class="dr-param">scope</dt>
2119 <dd class="dr-type"><em class="dr-type-object">object</em></dd>
2120 <dd class="dr-description">context for the event handlers</dd>
2121 <dt class="dr-param">varargs</dt>
2122 <dd class="dr-type"><em class="dr-type-...">...</em></dd>
2123 <dd class="dr-description">the rest of arguments will be sent to event handlers</dd>
2124 </dl>
2125 <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>
2126 </div><div class="extra"></div></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 101 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L101">&#x27ad;</a></h3>
2127 <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>.
2128 </p>
2129 <p class="header">Arguments
2130 </p>
2131 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2132 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2133 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated</dd>
2134 </dl>
2135 <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>
2136 </div><div class="extra"></div></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 198 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L198">&#x27ad;</a></h3>
2137 <div class="dr-method"><p>Could be used inside event handler to figure out actual name of the event.
2138 </p>
2139 <p class="header">Arguments
2140 </p>
2141 <dl class="dr-parameters"><dt class="dr-param optional">subname</dt>
2142 <dd class="dr-optional">optional</dd>
2143 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2144 <dd class="dr-description">subname of the event</dd>
2145 </dl>
2146 <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>
2147 <p>or
2148 </p>
2149 <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>
2150 </div><div class="extra"></div></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 156 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L156">&#x27ad;</a></h3>
2151 <div class="dr-method"><p>Binds given event handler with a given name. You can use wildcards “<code>*</code>” for the names:
2152 </p>
2153 <pre class="javascript code"><code>eve.on(<i>"*.under.*"</i>, f);
2154 eve(<i>"mouse.under.floor"</i>); <span class="c">// triggers f</span>
2155 </code></pre>
2156 <p>Use <a href="#eve" class="dr-link">eve</a> to trigger the listener.
2157 </p>
2158 <p class="header">Arguments
2159 </p>
2160 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2161 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2162 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated, with optional wildcards</dd>
2163 <dt class="dr-param">f</dt>
2164 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
2165 <dd class="dr-description">event handler function</dd>
2166 </dl>
2167 <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>
2168 <p class="header">Example:
2169 </p>
2170 <pre class="javascript code"><code>eve.on(<i>"mouse"</i>, eat)(<span class="d">2</span>);
2171 eve.on(<i>"mouse"</i>, scream);
2172 eve.on(<i>"mouse"</i>, <b>catch</b>)(<span class="d">1</span>);
2173 </code></pre>
2174 <p>This will ensure that <code>catch</code> function will be called before <code>eat</code>.
2175 If you want to put you hadler before not indexed handlers specify negative value.
2176 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”.
2177 </p>
2178 </div><div class="extra"></div></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 181 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L181">&#x27ad;</a></h3>
2179 <div class="dr-method"><p>Is used inside event handler to stop event
2180 </p>
2181 </div><div class="extra"></div></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 215 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L215">&#x27ad;</a></h3>
2182 <div class="dr-method"><p>Removes given function from the list of event listeners assigned to given name.
2183 </p>
2184 <p class="header">Arguments
2185 </p>
2186 <dl class="dr-parameters"><dt class="dr-param">name</dt>
2187 <dd class="dr-type"><em class="dr-type-string">string</em></dd>
2188 <dd class="dr-description">name of the event, dot (<code>.</code>) or slash (<code>/</code>) separated, with optional wildcards</dd>
2189 <dt class="dr-param">f</dt>
2190 <dd class="dr-type"><em class="dr-type-function">function</em></dd>
2191 <dd class="dr-description">event handler function</dd>
2192 </dl>
2193 </div><div class="extra"></div></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 272 in the source" href="https://github.com/DmitryBaranovskiy/eve/blob/master/eve.js#L272">&#x27ad;</a></h3>
2194 <div class="dr-property"><em class="dr-type dr-type-string">string</em><p>Current version of the library.
2195 </p>
2196 </div><div class="extra"></div></div></div></div></body></html>