Cross-browser vector graphics the easy way.
Raphaël is a small JavaScript library that should simplify your work with vector graphics on the web. If you want to create your own specific chart or image crop and rotate widget, for example, you can achieve it simply and easily with this library.
Raphaël uses the SVG W3C Recommendation and VML (a mostly equivalent implementation for Internet Explorer) as a base for drawing graphics. This means every graphical object you create is also a DOM object, so you can attach JavaScript event handlers or modify them later. Raphaël’s goal is to provide an adapter that will make drawing vector art cross-browser compatible and easy to do.
Raphaël currently supports Firefox 3.0+, Safari 3.0+, Opera 9.5+ and Internet Explorer 6.0+.
Download and include raphael.js (or, raphael-packed.js for a minimized version) into your HTML page. When it's loaded, use it as simply as:
// Creates canvas 320 × 200 at 10, 50
var paper = Raphael(10, 50, 320, 200);
// Creates circle at x = 50, y = 40, with radius 10
var circle = paper.circle(50, 40, 10);
// Sets the fill attribute of the circle to red (#f00)
circle.attr("fill", "#f00");
// Sets the stroke attribute of the circle to white (#fff)
circle.attr("stroke", "#fff");
This section provides a function reference for the Raphaël JavaScript library.
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.
- container HTMLElement or string
- width number
- height number
or
- x number
- y number
- width number
- height number
// 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);
Each object created on the canvas shares these same generic methods:
Gives you a reference to the DOM object, so you can assign event handlers or just mess around.
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"); };
Rotates the element by the given degree from either its 0,0 corner or its centre point.
- degree number Degree of rotation (0 – 360°)
- isAbsolute boolean [optional] Specifies the rotation point. Use
trueto rotate the element around its center point. The default,false, rotates the element from its 0,0 coordinate.
var c = paper.circle(10, 10, 10);
c.rotate(45); // rotation is relative
c.rotate(45, true); // rotation is absolute
Moves the element around the canvas by the given distances.
- dx number Pixels of translation by X axis
- dy number Pixels of translation by Y axis
var c = paper.circle(10, 10, 10);
c.translate(10, 10); // moves the circle down the canvas, in a diagonal line
Resizes the element by the given multiplier.
- Xtimes number Amount to scale horizontally
- Ytimes number Amount to scale vertically
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
Sets the attributes of elements directly.
- attributeName string
- value string
or
- params object
Please refer to the SVG specification for an explanation of these parameters.
- cx number
- cy number
- fill colour
- fill-opacity number
- font string
- font-family string
- font-size number
- font-weight string
- gradient object
- height number
- opacity number
- path pathString
- r number
- rotation number
- rx number
- ry number
- scale CSV
- stroke colour
- stroke-dasharray string [“-”, “.”, “-.”, “-..”, “. ”, “- ”, “--”, “- .”, “--.”, “--..”]
- stroke-linecap string [“butt”, “square”, “round”, “miter”]
- stroke-linejoin string [“butt”, “square”, “round”, “miter”]
- stroke-miterlimit number
- stroke-opacity number
- stroke-width number
- translation CSV
- width number
- x number
- y number
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
Linearly changes an attribute from its current value to its specified value in the given amount of milliseconds.
- newAttrs object A parameters object of the animation results. (Not all attributes can be animated.)
- ms number The duration of the animation, given in milliseconds.
- callback function [optional]
The newAttrs parameter accepts an object whose properties are the attributes to animate. However, not all attributes listed in the attr method reference can be animated. The following is a list of those properties that can be animated:
- cx number
- cy number
- fill colour
- fill-opacity number
- font-size number
- height number
- opacity number
- path pathString
- r number
- rotation number
- rx number
- ry number
- scale CSV
- stroke colour
- stroke-opacity number
- stroke-width number
- translation CSV
- width number
- x number
- y number
var c = paper.circle(10, 10, 10);
c.animate({cx: 20, r: 20}, 2000);
Returns the dimensions of an element.
var c = paper.circle(10, 10, 10);
var width = c.getBBox().width;
Moves the element so it is the closest to the viewer’s eyes, on top of other elements.
var c = paper.circle(10, 10, 10);
c.toFront();
Moves the element so it is the furthest from the viewer’s eyes, behind other elements.
var c = paper.circle(10, 10, 10);
c.toBack();
Inserts current object before the given one
var r = paper.rect(10, 10, 10, 10);
var c = paper.circle(10, 10, 10);
c.insertBefore(r);
Inserts current object after the given one
var c = paper.circle(10, 10, 10);
var r = paper.rect(10, 10, 10, 10);
c.insertAfter(r);
Draws a circle.
- x number X coordinate of the centre
- y number Y coordinate of the centre
- r number radius
var c = paper.circle(10, 10, 10);
Draws a rectangle.
- x number X coordinate of top left corner
- y number Y coordinate of top left corner
- width number
- height number
- r number [optional] radius for rounded corners, default is 0
// regular rectangle
var c = paper.rect(10, 10, 10, 10);
// rectangle with rounded corners
var c = paper.rect(10, 10, 100, 50, 10);
Draws an ellipse.
- x number X coordinate of the centre
- y number X coordinate of the centre
- rx number Horisontal radius
- ry number Vertical radius
var c = paper.ellipse(100, 100, 30, 40);
Embeds an image into the SVG/VML canvas.
- src string URI of the source image
- x number X coordinate position
- y number Y coordinate position
- width number Width of the image
- height number Height of the image
var c = paper.image("apple.png", 10, 10, 100, 100);
Draws a text string.
- x number X coordinate position
- y number Y coordinate position
- text string The text string to draw.
var t = paper.text(10, 10, "Look mom, I'm scalable!");
Initialises path drawing. Typically, this function returns an empty path object and to draw paths you use its built-in methods like lineTo and curveTo. However, you can also specify a path literally by supplying the path data as a second argument.
- params object Attributes for the resulting path as described in the
attrreference. - pathString string [optional] Path data in SVG path string format.
var c = paper.path({stroke: "#036"}).moveTo(10, 10).lineTo(50, 50); // draw a diagonal line
var c = paper.path({stroke: "#036"}, "M 10 10 L 50 50"); // same
Sets a trigger to count all following units as absolute ones, unless said otherwise. (This is on by default.)
var c = paper.path({stroke: "#036"}).absolutely()
.moveTo(10, 10).lineTo(50, 50);
Sets a trigger to count all following units as relative ones, unless said otherwise.
var c = paper.path({stroke: "#036"}).relatively()
.moveTo(10, 10).lineTo(50, 50);
Moves the drawing point to the given coordinates.
- x number X coordinate
- y number Y coordinate
// Begins drawing the path at coordinate 10,10
var c = paper.path({stroke: "#036"}).moveTo(10, 10).lineTo(50, 50);
Draws a straight line to the given coordinates.
- x number X coordinate
- y number Y coordinate
// Draws a line starting from 10,10 to 50,50
var c = paper.path({stroke: "#036"}).moveTo(10, 10).lineTo(50, 50);
Draws a curved line to the given coordinates. The line will have horizontal anchors on start and on finish.
- x number
- y number
- width number
var c = paper.path({stroke: "#036"}).moveTo(10, 10).cplineTo(50, 50);
Draws a bicubic curve to the given coordinates.
- x1 number
- y1 number
- x2 number
- y2 number
- x3 number
- y3 number
var c = paper.path({stroke: "#036"}).moveTo(10, 10).curveTo(10, 15, 45, 45, 50, 50);
Draws a quadratic curve to the given coordinates.
- x1 number
- y1 number
- x2 number
- y2 number
var c = paper.path({stroke: "#036"}).moveTo(10, 10).curveTo(10, 15, 45, 45, 50, 50);
Draws a quarter of a circle from the current drawing point.
- r number
- dir string Two-letter directional instruction, as described below.
Possible dir values
- dl: down left
- dr: down right
- ld: left down
- lu: left up
- rd: right down
- ru: right up
- ul: up left
- ur: up right
var c = paper.path({stroke: "#036"}).moveTo(10, 10).addRoundedCorner(10, "rd");
Closes the path being drawn.
var c = paper.path({stroke: "#036"}).moveTo(10, 10).andClose();
http://www.opensource.org/licenses/mit-license.php
Copyright (c) 2008 Dmitry Baranovskiy (http://raphaeljs.com)