"http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Raphaël Reference</title>
+ <meta http-equiv="content-language" content="en">
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="author" content="Dmitry Baranovskiy">
- <meta name="description" content="Vector Graphics JavaScript™ Library">
+ <meta name="description" content="Vector Graphics JavaScript Library">
+ <meta name="keywords" content="JavaScript Library, Raphael, SVG, VML">
+ <meta name="viewport" content="width=450; user-scalable=no">
+ <link rel="shortcut icon" href="/favicon16.png" type="image/x-icon">
<link rel="stylesheet" href="raphael.css" type="text/css" charset="utf-8" media="screen,projection">
- <link rel="stylesheet" type="text/css" media="print" href="/dmitry-print.css">
+ <link rel="stylesheet" type="text/css" media="print" href="print.css">
<link rel="shortcut icon" href="/favicon16.png" type="image/x-icon">
- <link rel="apple-touch-icon" href="/favicon.png">
- <script src="../jquery.js" type="text/javascript" charset="utf-8"></script>
- <script src="../dmitry.js" type="text/javascript" charset="utf-8"></script>
+ <link media="only screen and (max-device-width: 480px)" href="iphone.css" type="text/css" rel="stylesheet">
+ <script src="raphael.js" type="text/javascript" charset="utf-8"></script>
+ <script src="museo.js" type="text/javascript" charset="utf-8"></script>
+
+
</head>
- <body class="raphael" id="raphael.dmitry.baranovskiy.com">
+ <body class="raphael" id="reference">
<div id="header">
<a href="http://twitter.com/statuses/user_timeline/17180567.atom" id="rss" name="rss">rss</a>
<h1>
<div>
<div>
<div id="column-1">
- <h2 id="Raphael">
+ <h2>Main Function</h2>
+ <h3 id="Raphael">
Raphael
- </h2>
+ </h3>
<p>
- Function that creates canvas for future drawing.
+ Creates a canvas object on which to draw. You must do this first, as all future calls to drawing methods from this instance will be bound to this canvas.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
<li>container <em>HTMLElement</em> or <em>string</em></li>
<li>width <em>number</em></li>
<li>width <em>number</em></li>
<li>height <em>number</em></li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>
-// Creates canvas 320 × 200 at 10, 50</code>
-<code>var paper = Raphael(10, 50, 320, 200);</code>
-<code>var paper = Raphael(document.getElementById("notepad"), 320, 200);</code>
-<code>var paper = Raphael("notepad", 320, 200);</code></pre>
+ <p>or</p>
+ <ol>
+ <li>all <em>array</em> (first 3 or 4 elements in the array are equal to [containerID, width, height] or [x, y, width, height]. The rest are element descriptions in format {type: type, <attributes>})</li>
+ </ol>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>// Each of the following examples create a canvas that is 320px wide by 200px high
+// Canvas is created at the viewport's 10,50 coordinate
+var paper = Raphael(10, 50, 320, 200);
+// Canvas is created at the top left corner of the #notepad element (or its top right corner in dir="rtl" elements)
+var paper = Raphael(document.getElementById("notepad"), 320, 200);
+// Same as above
+var paper = Raphael("notepad", 320, 200);
+// Image dump
+var set = Raphael(["notepad", 320, 200, {type: "rect", x: 10, y: 10, width: 25, height: 25, stroke: "#f00"}, {type: "text", x: 30, y: 40, text: "Dump"}]);</code></pre>
<h2 id="Element">
- Element
+ Element’s generic methods
</h2>
<p>
- Object-wrapper for SVG/VML elements. Returned by Raphael methods.
+ Each object created on the canvas shares these same generic methods:
</p>
- <h2 id="zero">
- Element[0]
- </h2>
+ <h3 id="node">
+ node
+ </h3>
<p>
- Gives you reference to DOM object, so you can assign event handlers or just randomly mess around.
+ Gives you a reference to the DOM object, so you can assign event handlers or just mess around.
</p>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
-<code>c[0].onclick = function () { c.attr("fill", "red"); };</code></pre>
- <h2 id="rotate">
- Element.rotate
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10); // draw a circle at coordinate 10,10 with radius of 10
+c.node.onclick = function () { c.attr("fill", "red"); };</code></pre>
+ <h3 id="paper">
+ paper
+ </h3>
<p>
- Rotates element by given degree around its center.
+ Internal reference to “paper” where object drawn. Mainly for use in plugins and element extensions.
</p>
- <h3>Parameters</h3>
- <ol>
- <li>degree <em>number</em></li>
- </ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
-<code>c.rotate(45);</code></pre>
- <h2 id="translate">
- Element.translate
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>Raphael.el.cross = function () {
+ this.attr({fill: "red"});
+ this.paper.path("M10,10L50,50M50,10L10,50").attr({stroke: "red"});
+}</code></pre>
+ <h3 id="remove">
+ remove
+ </h3>
+ <p>
+ Removes element from the DOM. You can’t use it after this method call.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.remove();</code></pre>
+ <h3 id="hide">
+ hide
+ </h3>
+ <p>
+ Makes element invisible.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.hide();</code></pre>
+ <h3 id="show">
+ show
+ </h3>
<p>
- Moves element around the canvas by given dimensions.
+ Makes element visible.
</p>
- <h3>Parameters</h3>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.show();</code></pre>
+ <h3 id="rotate">
+ rotate
+ </h3>
+ <p>
+ Rotates the element by the given degree from its center point.
+ </p>
+ <h4>Parameters</h4>
<ol>
- <li>dx <em>number</em></li>
- <li>dy <em>number</em></li>
+ <li>degree <em>number</em> Degree of rotation (0 – 360°)</li>
+ <li>isAbsolute <em>boolean</em> [optional] Specifies is degree is relative to previous position (<code>false</code>) or is it absolute angle (<code>true</code>)</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
-<code>c.translate(10, 10);</code></pre>
- <h2 id="matrix">
- Element.matrix
- </h2>
+ <p>or</p>
+ <ol>
+ <li>degree <em>number</em> Degree of rotation (0 – 360°)</li>
+ <li>cx <em>number</em> [optional] X coordinate of the origin of rotation</li>
+ <li>cY <em>number</em> [optional] Y coordinate of the origin of rotation</li>
+ </ol>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.rotate(45); // rotation is relative
+c.rotate(45, true); // rotation is absolute</code></pre>
+ <h3 id="translate">
+ translate
+ </h3>
<p>
- Performs matrix transformation on element.
+ Moves the element around the canvas by the given distances.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>xx <em>number</em></li>
- <li>xy <em>number</em></li>
- <li>yx <em>number</em></li>
- <li>yy <em>number</em></li>
- <li>dx <em>number</em></li>
- <li>dy <em>number</em></li>
+ <li>dx <em>number</em> Pixels of translation by X axis</li>
+ <li>dy <em>number</em> Pixels of translation by Y axis</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
-<code>// reflects circle down</code>
-<code>c.matrix(1, 0, 0, -1, 0, 0);</code></pre>
- <h2 id="scale">
- Element.scale
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.translate(10, 10); // moves the circle down the canvas, in a diagonal line</code></pre>
+ <h3 id="scale">
+ scale
+ </h3>
<p>
- Scales element by given amount of times.
+ Resizes the element by the given multiplier.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>Xtimes <em>number</em></li>
- <li>Ytimes <em>number</em></li>
+ <li>Xtimes <em>number</em> Amount to scale horizontally</li>
+ <li>Ytimes <em>number</em> Amount to scale vertically</li>
+ <li>centerX <em>number</em> [optional] X of the center of scaling, default is the center of the element</li>
+ <li>centerY <em>number</em> [optional] Y of the center of scaling, default is the center of the element</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
-<code>c.scale(1.5, 1.5);</code></pre>
- <h2 id="attr">
- Element.attr
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.scale(1.5, 1.5); // makes the circle 1.5 times larger
+c.scale(.5, .75); // makes the circle half as wide, and 75% as high</code></pre>
+ <h3 id="attr">
+ attr
+ </h3>
<p>
- Sets attributes of elements.
+ Sets the attributes of elements directly.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
+ <ol>
+ <li>attributeName <em>string</em></li>
+ <li>value <em>string</em></li>
+ </ol>
+ <p>or</p>
<ol>
<li>params <em>object</em></li>
</ol>
<p>or</p>
<ol>
- <li>attribute <em>string</em></li>
- <li>value <em>string</em></li>
+ <li>attributeName <em>string</em> in this case method returns current value for given attribute name</li>
+ </ol>
+ <p>or</p>
+ <ol>
+ <li>attributeNames <em>array</em> in this case method returns array of current values for given attribute names</li>
</ol>
- <h3>Possible parameters</h3>
+ <p>or</p>
+ <p>no parameters, in this case object containing all attributes will be returned</p>
+ <h4>Possible parameters</h4>
+ <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>
<ul>
- <li>cx</li>
- <li>cy</li>
- <li>dasharray</li>
- <li>fill-opacity</li>
- <li>fill</li>
- <li>font-family</li>
- <li>font-size</li>
- <li>font-weight</li>
- <li>font</li>
- <li>gradient</li>
- <li>height</li>
- <li>joinstyle</li>
- <li>opacity</li>
- <li>r</li>
- <li>rx</li>
- <li>ry</li>
- <li>stroke-opacity</li>
- <li>stroke-width</li>
- <li>stroke</li>
- <li>width</li>
- <li>x</li>
- <li>y</li>
+ <li id="attr-clip-rect">clip-rect <em>string</em> comma or space separated values: x, y, width and height</li>
+ <li id="attr-cx">cx <em>number</em></li>
+ <li id="attr-cy">cy <em>number</em></li>
+ <li id="attr-fill">
+ fill <em>colour</em> or <em>gradient</em>
+ <ul>
+ <li>linear gradient: “‹angle›-‹colour›[-‹colour›[:‹offset›]]*-‹colour›”, example: <samp>"90-#fff-#000"</samp> – 90° gradient from white to black or <samp>"0-#fff-#f00:20-#000"</samp> – 0° gradient from white via red (at 20%) to black</li>
+ <li>radial gradient: “r[(‹fx›, ‹fy›)]‹colour›[-‹colour›[:‹offset›]]*-‹colour›”, example: <samp>“r#fff-#000”</samp> – gradient from white to black or <samp>“r(0.25, 0.75)#fff-#000”</samp> – gradient from white to black with focus point at 0.25, 0.75</li>
+ <li>Focus point coordinates are in 0..1 range</li>
+ <li>Radial gradients can only be applied to circles and ellipses</li>
+ </ul>
+ </li>
+ <li id="attr-fill-opacity">fill-opacity <em>number</em></li>
+ <li id="attr-font">font <em>string</em></li>
+ <li id="attr-font-family">font-family <em>string</em></li>
+ <li id="attr-font-size">font-size <em>number</em></li>
+ <li id="attr-font-weight">font-weight <em>string</em></li>
+ <li id="attr-height">height <em>number</em></li>
+ <li id="attr-opacity">opacity <em>number</em></li>
+ <li id="attr-path">path <em>pathString</em> <a href="http://www.w3.org/TR/SVG/paths.html#PathData" title="Details of a path’s data attribute’s format are described in the SVG specification.">SVG path string format</a></li>
+ <li id="attr-r">r <em>number</em></li>
+ <li id="attr-rotation">rotation <em>number</em></li>
+ <li id="attr-rx">rx <em>number</em></li>
+ <li id="attr-ry">ry <em>number</em></li>
+ <li id="attr-scale">scale <em>string</em> comma or space separated values: xtimes, ytimes, cx, cy. See: <a href="#scale">scale</a></li>
+ <li id="attr-src">src <em>string</em> (URL)</li>
+ <li id="attr-stroke">stroke <em>colour</em></li>
+ <li id="attr-stroke-dasharray">stroke-dasharray <em>string</em> [“”, “-”, “.”, “-.”, “-..”, “. ”, “- ”, “--”, “- .”, “--.”, “--..”]</li>
+ <li id="attr-stroke-linecap">stroke-linecap <em>string</em> [“butt”, “square”, “round”]</li>
+ <li id="attr-stroke-linejoin">stroke-linejoin <em>string</em> [“butt”, “square”, “round”, “miter”]</li>
+ <li id="attr-stroke-miterlimit">stroke-miterlimit <em>number</em></li>
+ <li id="attr-stroke-opacity">stroke-opacity <em>number</em></li>
+ <li id="attr-stroke-width">stroke-width <em>number</em></li>
+ <li id="attr-translation">translation <em>string</em> comma or space separated values: x and y</li>
+ <li id="attr-width">width <em>number</em></li>
+ <li id="attr-x">x <em>number</em></li>
+ <li id="attr-y">y <em>number</em></li>
</ul>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
-<code>c.attr("fill", "black");</code>
-<code>c.attr({fill: "#000", stroke: "#f00", opacity: 0.5});</code></pre>
- <h2 id="getBBox">
- Element.getBBox
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);
+c.attr("fill", "black"); // using strings
+c.attr({fill: "#000", stroke: "#f00", opacity: 0.5}); // using params object
+c.attr({fill: "90-#fff-#000", "stroke-dasharray": "-..", "clip-rect": "10, 10, 100, 100"});</code></pre>
+ <h3 id="animate">
+ animate
+ </h3>
<p>
- Returns dimensions of given element.
+ Changes an attribute from its current value to its specified value in the given amount of milliseconds.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>n/a</li>
+ <li>newAttrs <em>object</em> A parameters object of the animation results. (Not all attributes can be animated.)</li>
+ <li>ms <em>number</em> The duration of the animation, given in milliseconds.</li>
+ <li>callback <em>function</em> [optional]</li>
</ol>
- <h3>Usage</h3>
+ <p>or</p>
+ <ol>
+ <li>newAttrs <em>object</em> A parameters object of the animation results. (Not all attributes can be animated.)</li>
+ <li>ms <em>number</em> The duration of the animation, given in milliseconds.</li>
+ <li>easing <em>string</em> [“>”, “<”, “<>”, “backIn”, “backOut”, “bounce”, “elastic”] or <em>function</em> [optional]</li>
+ <li>callback <em>function</em> [optional]</li>
+ </ol>
+ <h4>Attributes that can be animated</h4>
+ <p>The <code>newAttrs</code> parameter accepts an object whose properties are the attributes to animate. However, not all attributes listed in the <code>attr</code> method reference can be animated. The following is a list of those properties that can be animated:</p>
+ <ul>
+ <li>clip-rect <em>string</em></li>
+ <li>cx <em>number</em></li>
+ <li>cy <em>number</em></li>
+ <li>fill <em>colour</em></li>
+ <li>fill-opacity <em>number</em></li>
+ <li>font-size <em>number</em></li>
+ <li>height <em>number</em></li>
+ <li>opacity <em>number</em></li>
+ <li>path <em>pathString</em></li>
+ <li>r <em>number</em></li>
+ <li>rotation <em>string</em></li>
+ <li>rx <em>number</em></li>
+ <li>ry <em>number</em></li>
+ <li>scale <em>string</em></li>
+ <li>stroke <em>colour</em></li>
+ <li>stroke-opacity <em>number</em></li>
+ <li>stroke-width <em>number</em></li>
+ <li>translation <em>string</em></li>
+ <li>width <em>number</em></li>
+ <li>x <em>number</em></li>
+ <li>y <em>number</em></li>
+ </ul>
+ <h4>Easing</h4>
+ <p>
+ For easing use built in functions or add your own by adding new functions to <code>Raphael.easing_formulas</code> object. Look at the <a href="easing.html">example of easing usage</a>.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
+<code>c.animate({cx: 20, r: 20}, 2000);</code>
+<code>c.animate({cx: 20, r: 20}, 2000, "bounce");</code></pre>
+ <h3 id="getBBox">
+ getBBox
+ </h3>
+ <p>
+ Returns the dimensions of an element.
+ </p>
+ <h4>Usage</h4>
<pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
<code>var width = c.getBBox().width;</code></pre>
- <h2 id="toFront">
- Element.toFront
- </h2>
+ <h3 id="toFront">
+ toFront
+ </h3>
<p>
- Moves element to front in hierarchy.
+ Moves the element so it is the closest to the viewer’s eyes, on top of other elements.
</p>
- <h3>Parameters</h3>
- <ol>
- <li>n/a</li>
- </ol>
- <h3>Usage</h3>
+ <h4>Usage</h4>
<pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
<code>c.toFront();</code></pre>
- <h2 id="circle">
- circle
- </h2>
+ <h3 id="toBack">
+ toBack
+ </h3>
+ <p>
+ Moves the element so it is the furthest from the viewer’s eyes, behind other elements.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code>
+<code>c.toBack();</code></pre>
+ <h3 id="insertBefore">
+ insertBefore
+ </h3>
+ <p>
+ Inserts current object before the given one.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var r = paper.rect(10, 10, 10, 10);</code>
+<code>var c = paper.circle(10, 10, 10);</code>
+<code>c.insertBefore(r);</code></pre>
+ <h3 id="insertAfter">
+ insertAfter
+ </h3>
<p>
- Creates circle.
+ Inserts current object after the given one.
</p>
- <h3>Parameters</h3>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var r = paper.rect(10, 10, 10, 10);
+var c = paper.circle(10, 10, 10);
+r.insertAfter(c);</code></pre>
+ <h3 id="clone">
+ clone
+ </h3>
+ <p>
+ Returns a clone of the current element.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var r = paper.rect(10, 10, 10, 10);
+var c = r.clone();</code></pre>
+ <h2>Graphic Primitives</h2>
+ <p>
+ Methods of “paper” object, created with <code>Raphael</code> function call.
+ </p>
+ <h3 id="raphael">
+ raphael
+ </h3>
+ <p>
+ Internal reference to <code>Raphael</code> object. In case it is not available.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>Raphael.el.red = function () {
+ var hsb = this.paper.raphael.rgb2hsb(this.attr("fill"));
+ hsb.h = 1;
+ this.attr({fill: this.paper.raphael.hsb2rgb(hsb).hex});
+}</code></pre>
+ <h3 id="setSize">
+ setSize
+ </h3>
+ <p>
+ If you need to change dimensions of the canvas call this method
+ </p>
+ <h4>Parameters</h4>
<ol>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
- <li>r <em>number</em></li>
+ <li>width <em>number</em> new width of the canvas</li>
+ <li>height <em>number</em> new height of the canvas</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.circle(10, 10, 10);</code></pre>
- <h2 id="rect">
- rect
- </h2>
+ <h3 id="setWindow">
+ setWindow
+ </h3>
<p>
- Creates rectangle.
+ Should be called before main Raphael method. Sets which window should be used for drawing. Default is the current one. You need to use it if you want to draw inside <code>iframe</code>
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
- <li>width <em>number</em></li>
- <li>height <em>number</em></li>
- <li>r <em>number</em> [optional]</li>
+ <li>window <em>object</em></li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>// regular rectangle</code>
-<code>var c = paper.rect(10, 10, 10, 10);</code>
-<code>// rounded rectangle</code>
-<code>var c = paper.rect(10, 10, 100, 50, 10);</code></pre>
- <h2 id="ellipse">
- ellipse
- </h2>
+ <h3 id="getRGB">
+ getRGB
+ </h3>
<p>
- Creates an ellipse.
+ Parses passes string and returns an color object. Especially usefull for plug-in developers.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
- <li>rx <em>number</em></li>
- <li>ry <em>number</em></li>
+ <li>color <em>string</em> Color in form acceptable by library</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.ellipse(100, 100, 30, 40);</code></pre>
- <h2 id="path">
- path
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var stroke = Raphael.getRGB(circle.attr("stroke")).hex</code></pre>
+ <h3 id="getColor">
+ getColor
+ </h3>
<p>
- Initialise path drawing. In general case this function returns empty path object. To draw path use built in methods like <code>lineTo</code> and <code>curveTo</code>.
+ Returns a colour object for the next colour in spectrum
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>params <em>object</em> Similar to object for <code><a href="#attr">attr</a></code> method</li>
- <li>pathString <em>string</em> [optional] path in SVG path string format. See SVG documentation.</li>
+ <li>value <em>number</em> brightness [optional]</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).lineTo(50, 50);</code></pre>
- <h2 id="absolutely">
- absolutely
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.path("M10,10L100,100").attr({stroke: Raphael.getColor()});</code></pre>
+ <h3 id="getColor-reset">
+ getColor.reset
+ </h3>
<p>
- Sets trigger to count all following units as absolute ones, unless said otherwise. [<em>on by default</em>]
+ Resets getColor function, so it will start from the beginning
</p>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).absolutely()
- .moveTo(10, 10).lineTo(50, 50);</code></pre>
- <h2 id="relatively">
- relatively
- </h2>
+ <h3 id="registerFont">
+ registerFont
+ </h3>
<p>
- Sets trigger to count all following units as relative ones, unless said otherwise.
+ Adds given font to the registered set of fonts for Raphaël. Should be used as an internal call from within Cufón’s font file. <a href="http://wiki.github.com/sorccu/cufon/about">More about Cufón and how to convert your font form TTF, OTF, etc to JavaScript file</a>. Returns original parameter, so it could be used with chaining.
</p>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).relatively()
- .moveTo(10, 10).lineTo(50, 50);</code></pre>
- <h2 id="redraw">
- redraw
- </h2>
+ <h4>Parameters</h4>
+ <ol>
+ <li>font <em>object</em> the font to register</li>
+ </ol>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>Cufon.registerFont(Raphael.registerFont({…}))</code></pre>
+ <h3 id="getFont">
+ getFont
+ </h3>
<p>
- Redraws the path. Make sense to use when points has been changed. This is possible via accessing <code>path</code>
- property of the object. This property is array of objects representing commands given to path.
+ 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”.
</p>
- <h3>Usage</h3>
- <pre class="javascript code"><code>c.path[3].arg[2] = 20;</code>
-<code>c.redraw();</code></pre>
- <h2 id="moveTo">
- moveTo
- </h2>
+ <h4>Parameters</h4>
+ <ol>
+ <li>family <em>string</em> font family name or any word from it</li>
+ <li>weight <em>string</em> weight of the font [optional]</li>
+ <li>style <em>string</em> style of the font [optional]</li>
+ <li>stretch <em>string</em> stretch of the font [optional]</li>
+ </ol>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>paper.print(100, 100, "Test string", paper.getFont("Times", 800), 30);</code></pre>
+ <h3 id="print">
+ print
+ </h3>
+ <div class="sample" id="print-sample"></div>
<p>
- Moves drawing point to given coordinates.
+ Creates set of shapes to represent given font at given position with given size. Result of the method is set object (see <a href="#set">set</a>) which contains each letter as separate path object.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
+ <li>x <em>number</em> x position of the text</li>
+ <li>y <em>number</em> y position of the text</li>
+ <li>text <em>string</em> text to print</li>
+ <li>font <em>object</em> font object (see <a href="#getFont">getFont</a>)</li>
+ <li>font_size <em>number</em> size of the font</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).lineTo(50, 50);</code></pre>
- <h2 id="lineTo">
- lineTo
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var txt = r.print(10, 50, "print", r.getFont("Museo"), 30).attr({fill: "#fff"});
+// following line will paint first letter in red
+txt[0].attr({fill: "#f00"});</code></pre>
+ <h3 id="circle">
+ circle
+ </h3>
+ <div class="sample" id="circle-sample"></div>
<p>
- Draws straight line to given coordinates.
+ Draws a circle.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
+ <li>x <em>number</em> X coordinate of the centre</li>
+ <li>y <em>number</em> Y coordinate of the centre</li>
+ <li>r <em>number</em> radius</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).lineTo(50, 50);</code></pre>
- <h2 id="cplineTo">
- cplineTo
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.circle(50, 50, 40);</code></pre>
+ <h3 id="rect">
+ rect
+ </h3>
+ <div class="sample" id="rect-sample"></div>
<p>
- Draws curved line to given coordinates. Line will have horizontal anchors on start and on finish.
+ Draws a rectangle.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
+ <li>x <em>number</em> X coordinate of top left corner</li>
+ <li>y <em>number</em> Y coordinate of top left corner</li>
<li>width <em>number</em></li>
+ <li>height <em>number</em></li>
+ <li>r <em>number</em> [optional] radius for rounded corners, default is 0</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).cplineTo(50, 50);</code></pre>
- <h2 id="curveTo">
- curveTo
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>// regular rectangle</code>
+<code>var c = paper.rect(10, 10, 50, 50);</code>
+<code>// rectangle with rounded corners</code>
+<code>var c = paper.rect(40, 40, 50, 50, 10);</code></pre>
+ <h3 id="ellipse">
+ ellipse
+ </h3>
+ <div class="sample" id="ellipse-sample"></div>
<p>
- Draws curved line to given coordinates.
+ Draws an ellipse.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>x1 <em>number</em></li>
- <li>y1 <em>number</em></li>
- <li>x2 <em>number</em></li>
- <li>y2 <em>number</em></li>
- <li>x3 <em>number</em></li>
- <li>y3 <em>number</em></li>
+ <li>x <em>number</em> X coordinate of the centre</li>
+ <li>y <em>number</em> X coordinate of the centre</li>
+ <li>rx <em>number</em> Horisontal radius</li>
+ <li>ry <em>number</em> Vertical radius</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).curveTo(10, 15, 45, 45, 50, 50);</code></pre>
- <h2 id="addRoundedCorner">
- addRoundedCorner
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.ellipse(50, 50, 40, 20);</code></pre>
+ <h3 id="image">
+ image
+ </h3>
+ <div class="sample" id="image-sample"></div>
<p>
- Draws quarter of circle form current point.
+ Embeds an image into the SVG/VML canvas.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>r <em>number</em></li>
- <li>dir <em>string</em> two letters direction</li>
+ <li>src <em>string</em> URI of the source image</li>
+ <li>x <em>number</em> X coordinate position</li>
+ <li>y <em>number</em> Y coordinate position</li>
+ <li>width <em>number</em> Width of the image</li>
+ <li>height <em>number</em> Height of the image</li>
</ol>
- <h3>Possible dir values</h3>
- <dl>
- <dt>lu</dt>
- <dd>left up</dd>
- <dt>ld</dt>
- <dd>left down</dd>
- <dt>ru</dt>
- <dd>right up</dd>
- <dt>rd</dt>
- <dd>right down</dd>
- <dt>ur</dt>
- <dd>up right</dd>
- <dt>ul</dt>
- <dd>up left</dd>
- <dt>dr</dt>
- <dd>down right</dd>
- <dt>dl</dt>
- <dd>down left</dd>
- </dl>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).addRoundedCorner(10, "rd");</code></pre>
- <h2 id="andClose">
- andClose
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.image("apple.png", 10, 10, 80, 80);</code></pre>
+ <h3 id="set">
+ set
+ </h3>
+ <div class="sample" id="set-sample"></div>
<p>
- Closes the path.
+ Creates array-like object to keep and operate couple of elements at once. Warning: it doesn’t create any elements for itself in the page.
</p>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.path({stroke: "#036"}).moveTo(10, 10).andClose();</code></pre>
- <h2 id="image">
- image
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var st = paper.set();</code>
+<code>st.push(paper.circle(10, 10, 5), paper.circle(30, 10, 5));</code>
+<code>st.attr({fill: "red"});</code></pre>
+ <h3 id="text">
+ text
+ </h3>
+ <div class="sample" id="text-sample"></div>
<p>
- Embeds an image in SVG/VML area.
+ Draws a text string. If you need line breaks, put “\n” in the string.
</p>
- <h3>Parameters</h3>
+ <h4>Parameters</h4>
<ol>
- <li>src <em>string</em></li>
- <li>x <em>number</em></li>
- <li>y <em>number</em></li>
- <li>width <em>number</em></li>
- <li>height <em>number</em></li>
+ <li>x <em>number</em> X coordinate position.</li>
+ <li>y <em>number</em> Y coordinate position.</li>
+ <li>text <em>string</em> The text string to draw.</li>
</ol>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.image("apple.png", 10, 10, 100, 100);</code></pre>
- <h2 id="group">
- group
- </h2>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var t = paper.text(50, 50, "Raphaël\nkicks\nbutt!");</code></pre>
+ <h3 id="path">
+ path
+ </h3>
+ <div class="sample" id="path-sample"></div>
+ <p>
+ Initialises path drawing. You can specify a path by supplying the path data as a second argument.
+ </p>
+ <h4>Parameters</h4>
+ <ol>
+ <li>pathString <em>string</em> [optional] Path data in <a href="http://www.w3.org/TR/SVG/paths.html#PathData" title="Details of a path's data attribute's format are described in the SVG specification.">SVG path string format</a>.</li>
+ </ol>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>var c = paper.path("M10 10L90 90");
+// draw a diagonal line: move to 10,10, line to 90,90</code></pre>
+ <h3 id="plugins-canvas">
+ Adding your own methods to canvas
+ </h3>
+ <p>
+ You can add your own method to the canvas. For example if you want to draw pie chart, you can create your own pie chart function and ship it as a Raphaël plugin. To do this you need to extend Raphael.fn object. Please note that you can create your own namespaces inside fn object. Methods will be run in context of canvas anyway. You should alter fn object before Raphaël instance was created, otherwise it will take no effect.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>Raphael.fn.arrow = function (x1, y1, x2, y2, size) {
+ return this.path(// some code here);
+};
+// or create namespace
+Raphael.fn.mystuff = {
+ arrow: function () {…},
+ star: function () {…},
+ // etc…
+};
+var paper = Raphael(10, 10, 630, 480);
+// then use it
+paper.arrow(10, 10, 30, 30, 5).attr({fill: "#f00"});
+paper.mystuff.arrow();
+paper.mystuff.star();
+</code></pre>
+ <h3 id="plugins-elements">
+ Adding your own methods to elements
+ </h3>
+ <p>
+ You can add your own method to elements. This is usefull when you want to hack default functionality or want to wrap some common transformation or attributes in one method. In difference to canvas mathods, you can redefine element method at any time.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>Raphael.el.red = function () {
+ this.attr({fill: "#f00"});
+};
+// then use it
+paper.circle(100, 100, 20).red();
+</code></pre>
+ <h3 id="colour">
+ Supported colour formats
+ </h3>
<p>
- Creates a group. Could be useful if you want to group your objects in layers, etc.
+ You could specify colour in this formats:
</p>
- <h3>Usage</h3>
- <pre class="javascript code"><code>var c = paper.group();</code></pre>
+ <ul>
+ <li>Colour name (“red”, “green”, “cornflowerblue”, etc)</li>
+ <li>#••• — shortened HTML colour: (“#000”, “#fc0”, etc)</li>
+ <li>#•••••• — full length HTML colour: (“#000000”, “#bd2300”)</li>
+ <li>rgb(•••, •••, •••) — red, green and blue channels’ values: (“rgb(200, 100, 0)”)</li>
+ <li>rgb(•••%, •••%, •••%) — same as above, but in %: (“rgb(100%, 175%, 0%)”)</li>
+ <li>hsb(•••, •••, •••) — hue, saturation and brightness values: (“hsb(0.5, 0.25, 1)”)</li>
+ <li>hsb(•••%, •••%, •••%) — same as above, but in %</li>
+ <li>hsl(•••, •••, •••) — same as hsb</li>
+ <li>hsl(•••%, •••%, •••%) — same as hsb</li>
+ </ul>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>paper.circle(100, 100, 20).attr({fill: "hsb(1, 255, 200)", stroke: "red"});</code></pre>
+ <h3 id="safari">
+ safari
+ </h3>
+ <p>
+ There is an inconvenient rendering bug is Safari (WebKit): sometimes the rendering should be forced. This method should help with dealing with this bug.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>paper.safari();</code></pre>
+ <h3 id="ninja-mode">
+ “Ninja Mode”
+ </h3>
+ <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. Beware, that in this case plugins could stop working, because they are depending on global variable existance.
+ </p>
+ <h4>Usage</h4>
+ <pre class="javascript code"><code>(function (local_raphael) {
+ var paper = local_raphael(10, 10, 320, 200);
+ …
+})(Raphael.ninja());
+</code></pre>
</div>
<div id="column-2">
<h2>
<h2>
Contents
</h2>
- <ul>
+ <ul id="contents">
<li>
- <a href="reference.html#Raphael"><code>Raphael</code></a>
+ <a href="#Raphael"><code>Raphael</code></a>
</li>
<li>
- <a href="reference.html#Element"><code>Element</code></a>
- <ul>
- <li>
- <a href="reference.html#zero"><code>0</code></a>
- </li>
- <li>
- <a href="reference.html#rotate"><code>rotate</code></a>
- </li>
- <li>
- <a href="reference.html#translate"><code>translate</code></a>
- </li>
- <li>
- <a href="reference.html#matrix"><code>matrix</code></a>
- </li>
- <li>
- <a href="reference.html#scale"><code>scale</code></a>
- </li>
- <li>
- <a href="reference.html#attr"><code>attr</code></a>
- </li>
- <li>
- <a href="reference.html#getBBox"><code>getBBox</code></a>
- </li>
- <li>
- <a href="reference.html#toFront"><code>toFront</code></a>
- </li>
- </ul>
+ <a href="#node"><code>node</code></a>
</li>
<li>
- <a href="reference.html#circle"><code>circle</code></a>
+ <a href="#paper"><code>paper</code></a>
</li>
<li>
- <a href="reference.html#rect"><code>rect</code></a>
+ <a href="#remove"><code>remove</code></a>
</li>
<li>
- <a href="reference.html#ellipse"><code>ellipse</code></a>
+ <a href="#hide"><code>hide</code></a>
</li>
<li>
- <a href="reference.html#path"><code>path</code></a>
- <ul>
- <li>
- <a href="reference.html#absolutely"><code>absolutely</code></a>
- </li>
- <li>
- <a href="reference.html#relatively"><code>relatively</code></a>
- </li>
- <li>
- <a href="reference.html#redraw"><code>redraw</code></a>
- </li>
- <li>
- <a href="reference.html#moveTo"><code>moveTo</code></a>
- </li>
- <li>
- <a href="reference.html#lineTo"><code>lineTo</code></a>
- </li>
- <li>
- <a href="reference.html#cplineTo"><code>cplineTo</code></a>
- </li>
- <li>
- <a href="reference.html#curveTo"><code>curveTo</code></a>
- </li>
- <li>
- <a href="reference.html#addRoundedCorner"><code>addRoundedCorner</code></a>
- </li>
- <li>
- <a href="reference.html#andClose"><code>andClose</code></a>
- </li>
- </ul>
+ <a href="#show"><code>show</code></a>
+ </li>
+ <li>
+ <a href="#rotate"><code>rotate</code></a>
+ </li>
+ <li>
+ <a href="#translate"><code>translate</code></a>
+ </li>
+ <li>
+ <a href="#scale"><code>scale</code></a>
+ </li>
+ <li>
+ <a href="#attr"><code>attr</code></a>
+ </li>
+ <li>
+ <a href="#animate"><code>animate</code></a>
+ </li>
+ <li>
+ <a href="#getBBox"><code>getBBox</code></a>
+ </li>
+ <li>
+ <a href="#toFront"><code>toFront</code></a>
+ </li>
+ <li>
+ <a href="#toBack"><code>toBack</code></a>
+ </li>
+ <li>
+ <a href="#insertBefore"><code>insertBefore</code></a>
+ </li>
+ <li>
+ <a href="#insertAfter"><code>insertAfter</code></a>
+ </li>
+ <li>
+ <a href="#clone"><code>clone</code></a>
+ </li>
+ <li>
+ <a href="#raphael"><code>raphael</code></a>
+ </li>
+ <li>
+ <a href="#setSize"><code>setSize</code></a>
+ </li>
+ <li>
+ <a href="#setWindow"><code>setWindow</code></a>
+ </li>
+ <li>
+ <a href="#getRGB"><code>getRGB</code></a>
+ </li>
+ <li>
+ <a href="#getColor"><code>getColor</code></a>
+ </li>
+ <li>
+ <a href="#getColor-reset"><code>getColor.reset</code></a>
+ </li>
+ <li>
+ <a href="#registerFont"><code>registerFont</code></a>
+ </li>
+ <li>
+ <a href="#getFont"><code>getFont</code></a>
+ </li>
+ <li>
+ <a href="#print"><code>print</code></a>
+ </li>
+ <li>
+ <a href="#circle"><code>circle</code></a>
+ </li>
+ <li>
+ <a href="#rect"><code>rect</code></a>
+ </li>
+ <li>
+ <a href="#ellipse"><code>ellipse</code></a>
+ </li>
+ <li>
+ <a href="#image"><code>image</code></a>
+ </li>
+ <li>
+ <a href="#set"><code>set</code></a>
+ </li>
+ <li>
+ <a href="#text"><code>text</code></a>
+ </li>
+ <li>
+ <a href="#path"><code>path</code></a>
+ </li>
+ <li>
+ <a href="#plugins-canvas">Adding your own methods to canvas</a>
+ </li>
+ <li>
+ <a href="#plugins-elements">Adding your own methods to elements</a>
</li>
<li>
- <a href="reference.html#image"><code>image</code></a>
+ <a href="#colour">Supported colour formats</a>
</li>
<li>
- <a href="reference.html#group"><code>group</code></a>
+ <a href="#safari">safari</a>
</li>
<li>
- <a href="reference.html#linerect"><code>linerect</code></a>
+ <a href="#ninja-mode">“Ninja Mode”</a>
</li>
</ul>
</div>
<div id="footer">
<h3 id="copyright">
- <a href="http://
creativecommons.org/licenses/by-sa/3.0/" title="Creative Commons Attribution-ShareAlike 3.0 Unported" rel="license">Some Rights Reserved</a> by <a href="http://dmitry.baranovskiy.com/">Dmitry Baranovskiy</a>
+ <a href="http://
www.opensource.org/licenses/mit-license.php" title="MIT License" rel="license">Some Rights Reserved</a> by <a href="http://dmitry.baranovskiy.com/">Dmitry Baranovskiy</a>
</h3>
<h3 id="font">
- A font by <a href="http://www.exljbris.nl">Jos Buivenga</a> | Logo by <a href="http://wasabicube.com/">Wasabicube</a>
+ Logo by <a href="http://wasabicube.com/">Wasabicube</a> ·
+ Work at this project started as 20% time at <a href="http://www.atlassian.com/" title="Atlassian — Software to Track, Test & Collaborate, from Enterprises to Open Source Projects.">Atlassian</a>
</h3>
</div>
</div>
</div>
</div>
+ <script src="syntax.js" type="text/javascript" charset="utf-8"></script>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
projects / raphael / blobdiff