raphael.js

Main Function

- Raphael -

- 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. -

Parameters

container HTMLElement or string
width number
height number

x number
y number
width number
height number

all array (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>})

Usage

// 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"
+
+RaphaÃ«l ReferenceAnimation
Animation.delay()
Animation.repeat()
Element
Element.animate()
Element.clone()
Element.getBBox()
Element.getPointAtLength()
Element.getSubpath()
Element.getTotalLength()
Element.glow()
Element.rotate()
Element.scale()
Element.setTime()
Element.status()
Element.transform()
Element.translate()
Paper
Paper.bottom
Paper.circle()
Paper.ellipse()
Paper.forEach()
Paper.getById()
Paper.getElementByPoint()
Paper.image()
Paper.path()
Paper.raphael
Paper.rect()
Paper.set()
Paper.setSize()
Paper.text()
Paper.top
Raphael()
Raphael.angle()
Raphael.animation()
Raphael.deg()
Raphael.easing_formulas
Raphael.findDotsAtSegment()
Raphael.fn
Raphael.getColor()
Raphael.getColor.reset()
Raphael.getPointAtLength()
Raphael.getRGB()
Raphael.getSubpath()
Raphael.getTotalLength()
Raphael.hsb()
Raphael.hsb2rgb()
Raphael.hsl()
Raphael.hsl2rgb()
Raphael.is()
Raphael.parsePathString()
Raphael.parseTransformString()
Raphael.path2curve()
Raphael.pathToRelative()
Raphael.rad()
Raphael.rgb()
Raphael.rgb2hsb()
Raphael.rgb2hsl()
Raphael.setWindow()
Raphael.snapTo()
Raphael.svg
Raphael.type
Raphael.vml
RaphaÃ«l Reference
Check out the source: raphael.js
Animation⚓➭
+Animation.delay(delay)⚓➭
+Creates copy of existing animation object with given delay.
+Parameters
+
+delay
+number
+number of ms to pass between animation start and actual animation
+
+Returns: object new altered Animation object
+
Animation.repeat(repeat)⚓➭
+Creates copy of existing animation object with given repetition.
+Parameters
+
+repeat
+number
+number iterations of animation. For infinite animation pass Infinity
+
+Returns: object new altered Animation object
+
Element⚓➭
+Element.animate(â¦)⚓➭
+Creates and starts animation for given element.
+Parameters
+
+params
+object
+final attributes for the element, see also Element.attr
+ms
+number
+number of milliseconds for animation to run
+easing
+optional
+string
+easing type. Accept on of Raphael.easing_formulas or CSS format: cubic-bezier(XX, XX, XX, XX)
+callback
+optional
+function
+callback function. Will be called at the end of animation.
+
+or
+animation
+object
+animation object, see Raphael.animation
+
+Returns: object original element
+
Element.clone()⚓➭
+Returns: object clone of a given element
+
Element.getBBox(isWithoutTransform)⚓➭
+Return bounding box for a given element
+Parameters
+
+isWithoutTransform
+boolean
+flag, true if you want to have bounding box before transformations. Default is false.
+
+Returns: object Bounding box object:
+{
+    x: //top left corner x,
+    y: //top left corner y,
+    width: //width,
+    height: //height
+}
+
+
Element.getPointAtLength(length)⚓➭
+Return coordinates of the point located at the given length on the given path. Only works for element of âpathâ type.
+Parameters
+
+length
+number
+ 
+
+Returns: object representation of the point:
+{
+    x: //x coordinate,
+    y: //y coordinate,
+    alpha: //angle of derivative
+}
+
+
Element.getSubpath(from, to)⚓➭
+Return subpath of a given element from given length to given length. Only works for element of âpathâ type.
+Parameters
+
+from
+number
+position of the start of the segment
+to
+number
+position of the end of the segment
+
+Returns: string pathstring for the segment
+
Element.getTotalLength()⚓➭
+Returns length of the path in pixels. Only works for element of âpathâ type.
+Returns: number length.
+
Element.glow()⚓➭
+Return set of elements that create glow-like effect around given element. See Paper.set.
+Note: Glow is not connected to the elment. If you change element attributes it wonât adjust itself.
+Returns: object set of elements that represents glow
+
Element.rotate(deg, [cx], [cy])⚓➭
+Adds rotation by given angle around given point to the list oftransformations of the element.
+Parameters
+
+deg
+number
+angle in degrees
+cx
+optional
+number
+x coordinate of the centre of rotation
+cy
+optional
+number
+y coordinate of the centre of rotation
+
+If cx & cy arenât specified centre of the shape is used as a point of rotation.
+Returns: object Element
+
Element.scale(sx, sy, [cx], [cy])⚓➭
+Adds scale by given amount relative to given point to the list oftransformations of the element.
+Parameters
+
+sx
+number
+horisontal scale amount
+sy
+number
+vertical scale amount
+cx
+optional
+number
+x coordinate of the centre of scale
+cy
+optional
+number
+y coordinate of the centre of scale
+
+If cx & cy arenât specified centre of the shape is used instead.
+Returns: object Element
+
Element.setTime(anim, value)⚓➭
+Sets the status of animation of the element in milliseconds. Similar to Element.status method.
+Parameters
+
+anim
+object
+animation object
+value
+number
+number of milliseconds from the beginning of the animation
+
+Returns: object original element if value is specified
+
Element.status([anim], [value])⚓➭
+Gets or sets the status of animation of the element.
+Parameters
+
+anim
+optional
+object
+animation object
+value
+optional
+number
+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.
+
+Returns: number status
+or
+Returns: array status if anim is not specified in format:
+[{
+    anim: // animation object,
+    status: // status
 }, {
-    type: "text",
-    x: 30,
-    y: 40,
-    text: "Dump"
-}]);
-                        
-                            circle
-                        
-                        
-                        
-                            Draws a circle.
-                        
-                        Parameters
-                        
-                            x number X coordinate of the centre
-                            y number Y coordinate of the centre
-                            r number radius
-                        
-                        Usage
-                        var c = paper.circle(50, 50, 40);
-                        
-                            rect
-                        
-                        
-                        
-                            Draws a rectangle.
-                        
-                        Parameters
-                        
-                            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
-                        
-                        Usage
-                        // regular rectangle
-var c = paper.rect(10, 10, 50, 50);
-// rectangle with rounded corners
-var c = paper.rect(40, 40, 50, 50, 10);
-                        
-                            ellipse
-                        
-                        
-                        
-                            Draws an ellipse.
-                        
-                        Parameters
-                        
-                            x number X coordinate of the centre
-                            y number X coordinate of the centre
-                            rx number Horisontal radius
-                            ry number Vertical radius
-                        
-                        Usage
-                        var c = paper.ellipse(50, 50, 40, 20);
-                        
-                            image
-                        
-                        
-                        
-                            Embeds an image into the SVG/VML canvas.
-                        
-                        Parameters
-                        
-                            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
-                        
-                        Usage
-                        var c = paper.image("apple.png", 10, 10, 80, 80);
-                        
-                            set
-                        
-                        
-                        
-                            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.
-                        
-                        Usage
-                        var st = paper.set();
-st.push(
-    paper.circle(10, 10, 5),
-    paper.circle(30, 10, 5)
-);
-st.attr({fill: "red"});
-                        
-                            text
-                        
-                        
-                        
-                            Draws a text string. If you need line breaks, put â\nâ in the string.
-                        
-                        Parameters
-                        
-                            x number X coordinate position.
-                            y number Y coordinate position.
-                            text string The text string to draw.
-                        
-                        Usage
-                        var t = paper.text(50, 50, "RaphaÃ«l\nkicks\nbutt!");
-                        
-                            path
-                        
-                        
-                        
-                            Creates a path element by given path data string.
-                        
-                        Parameters
-                        
-                            pathString string [optional] Path data in SVG path string format.
-                        
-                        Usage
-                        var c = paper.path("M10 10L90 90");
-// draw a diagonal line:
-// move to 10,10, line to 90,90
-                        
-                            clear
-                        
-                        
-                            Clears the canvas, i.e. removes all the elements.
-                        
-                        Usage
-                        var c = paper.path("M10 10L90 90");
-paper.clear();
-                        
-                            Elementâs generic methods
-                        
-                        
-                            Each object created on the canvas shares these same generic methods:
-                        
-                        
-                            node
-                        
-                        
-                            Gives you a reference to the DOM object, so you can assign event handlers or just mess around.
-                        
-                        Usage
-                        // draw a circle at coordinate 10,10 with radius of 10
-var c = paper.circle(10, 10, 10);
-c.node.onclick = function () {
-    c.attr("fill", "red");
-};
-                        
-                            paper
-                        
-                        
-                            Internal reference to âpaperâ where object drawn. Mainly for use in plugins and element extensions.
-                        
-                        Usage
-                        Raphael.el.cross = function () {
-    this.attr({fill: "red"});
-    this.paper.path("M10,10L50,50M50,10L10,50")
-        .attr({stroke: "red"});
-}
-                        
-                            remove
-                        
-                        
-                            Removes element from the DOM. You canât use it after this method call.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.remove();
-                        
-                            hide
-                        
-                        
-                            Makes element invisible.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.hide();
-                        
-                            show
-                        
-                        
-                            Makes element visible.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.show();
-                        
-                            rotate
-                        
-                        
-                            Rotates the element by the given degree from its center point.
-                        
-                        Parameters
-                        
-                            degree number Degree of rotation (0 â 360Â°)
-                            isAbsolute boolean [optional] Specifies is degree is relative to previous position (false) or is it absolute angle (true)
-                        
-                        or
-                        
-                            degree number Degree of rotation (0 â 360Â°)
-                            cx number [optional] X coordinate of the origin of rotation
-                            cY number [optional] Y coordinate of the origin of rotation
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.rotate(45);        // rotation is relative
-c.rotate(45, true);  // rotation is absolute
-                        
-                            translate
-                        
-                        
-                            Moves the element around the canvas by the given distances.
-                        
-                        Parameters
-                        
-                            dx number Pixels of translation by X axis
-                            dy number Pixels of translation by Y axis
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-// moves the circle 10 px to the right and down
-c.translate(10, 10);
-                        
-                            scale
-                        
-                        
-                            Resizes the element by the given multiplier.
-                        
-                        Parameters
-                        
-                            Xtimes number Amount to scale horizontally
-                            Ytimes number Amount to scale vertically
-                            centerX number [optional] X of the center of scaling, default is the center of the element
-                            centerY number [optional] Y of the center of scaling, default is the center of the element
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-// makes the circle 1.5 times larger
-c.scale(1.5, 1.5);
-// makes the circle half as wide, and 75% as high
-c.scale(.5, .75);
-                        
-                            attr
-                        
-                        
-                            Sets the attributes of elements directly.
-                        
-                        Parameters
-                        
-                            attributeName string
-                            value string
-                        
-                        or
-                        
-                            params object
-                        
-                        or
-                        
-                            attributeName string in this case method returns current value for given attribute name
-                        
-                        or
-                        
-                            attributeNames array in this case method returns array of current values for given attribute names
-                        
-                        or
-                        no parameters, in this case object containing all attributes will be returned
-                        Possible parameters
-                        Please refer to the SVG specification for an explanation of these parameters.
-                        
-                            clip-rect string comma or space separated values: x, y, width and height
-                            cursor string CSS type of the cursor
-                            cx number
-                            cy number
-                            
-                                fill colour or gradient
-                                
-                                    linear gradient: ââ¹angleâº-â¹colourâº[-â¹colourâº[:â¹offsetâº]]*-â¹colourâºâ, example: â90-#fff-#000â â 90Â° gradient from white to black or â0-#fff-#f00:20-#000â â 0Â° gradient from white via red (at 20%) to black
-                                    radial gradient: âr[(â¹fxâº, â¹fyâº)]â¹colourâº[-â¹colourâº[:â¹offsetâº]]*-â¹colourâºâ, example: âr#fff-#000â â gradient from white to black or âr(0.25, 0.75)#fff-#000â â gradient from white to black with focus point at 0.25, 0.75
-                                    Focus point coordinates are in 0..1 range
-                                    Radial gradients can only be applied to circles and ellipses
-                                
-                            
-                            fill-opacity number
-                            font string
-                            font-family string
-                            font-size number
-                            font-weight string
-                            height number
-                            href string URL, if specified element behaves as hyperlink
-                            opacity number
-                            path pathString SVG path string format
-                            r number
-                            rotation number
-                            rx number
-                            ry number
-                            scale string comma or space separated values: xtimes, ytimes, cx, cy. See: scale
-                            src string (URL)
-                            stroke colour
-                            stroke-dasharray string [ââ, â-â, â.â, â-.â, â-..â, â. â, â- â, â--â, â- .â, â--.â, â--..â]
-                            stroke-linecap string [âbuttâ, âsquareâ, âroundâ]
-                            stroke-linejoin string [âbevelâ, âroundâ, âmiterâ]
-                            stroke-miterlimit number
-                            stroke-opacity number
-                            stroke-width number
-                            target string used with href
-                            text-anchor string [âstartâ, âmiddleâ, âendâ], default is âmiddleâ
-                            title string will create tooltip with a given text
-                            translation string comma or space separated values: x and y
-                            width number
-                            x number
-                            y number
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-// using strings
-c.attr("fill", "black");
-// using params object
-c.attr({fill: "#000", stroke: "#f00", opacity: 0.5});
-c.attr({
-    fill: "90-#fff-#000",
-    "stroke-dasharray": "-..",
-    "clip-rect": "10, 10, 100, 100"
-});
-                        
-                            animate
-                        
-                        
-                            Changes an attribute from its current value to its specified value in the given amount of milliseconds.
-                        
-                        Parameters
-                        
-                            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]
-                        
-                        or
-                        
-                            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.
-                            easing string [â>â, â<â, â<>â, âbackInâ, âbackOutâ, âbounceâ, âelasticâ, âcubic-bezier(p1, p2, p3, p4)â] or function [optional], see explanation re cubic-bezier syntax
-                            callback function [optional]
-                        
-                        or
-                        
-                            keyFrames object Key-value map, where key represents keyframe timing: [âfromâ, â20%â, âtoâ, â35%â, etc] and value is the same as newAttrs from above, except it could also have easing and callback properties
-                            ms number The duration of the animation, given in milliseconds.
-                        
-                        Look at the example of keyframes usage
-                        Attributes that can be animated
-                        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:
-                        
-                            clip-rect string
-                            cx number
-                            cy number
-                            fill colour
-                            fill-opacity number
-                            font-size number
-                            height number
-                            opacity number
-                            path pathString
-                            r number
-                            rotation string
-                            rx number
-                            ry number
-                            scale string
-                            stroke colour
-                            stroke-opacity number
-                            stroke-width number
-                            translation string
-                            width number
-                            x number
-                            y number
-                        
-                        Easing
-                        
-                            For easing use built in functions or add your own by adding new functions to Raphael.easing_formulas object. Look at the example of easing usage.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.animate({cx: 20, r: 20}, 2000);
-c.animate({cx: 20, r: 20}, 2000, "bounce");
-c.animate({
-    "20%": {cx: 20, r: 20, easing: ">"},
-    "50%": {cx: 70, r: 120, callback: function () {â¦}},
-    "100%": {cx: 10, r: 10}
-}, 2000);
-                        
-                            animateWith
-                        
-                        
-                            The same as animate method, but synchronise animation with another element.
-                        
-                        Parameters
-                        The same as for animate method, but first argument is an element.
-                        Usage
-                        var c = paper.circle(10, 10, 10),
-    r = paper.rect(10, 10, 10, 10);
-c.animate({cx: 20, r: 20}, 2000);
-r.animateWith(c, {x: 20}, 2000);
-                        
-                            animateAlong
-                        
-                        
-                        
-                            Animates element along the given path. As an option it could rotate element along the path.
-                        
-                        Parameters
-                        
-                            path object or string path element or path string along which the element will be animated
-                            ms number The duration of the animation, given in milliseconds.
-                            rotate boolean [optional] if true, element will be rotated along the path
-                            callback function [optional]
-                        
-                        Usage
-                        var p = r.path("M100,100c0,50 100-50 100,0c0,50 -100-50 -100,0z").attr({stroke: "#ddd"}),
-    e = r.ellipse(104, 100, 4, 4).attr({stroke: "none", fill: "#f00"}),
-    b = r.rect(0, 0, 620, 400).attr({stroke: "none", fill: "#000", opacity: 0}).click(function () {
-        e.attr({rx: 5, ry: 3}).animateAlong(p, 4000, true, function () {
-            e.attr({rx: 4, ry: 4});
-        });
-    });
-                        
-                            animateAlongBack
-                        
-                        
-                            Similar to animateAlong. Animates element along the given path, starting from the end of it.
-                        
-                        
-                            onAnimation
-                        
-                        
-                        
-                            Sets or resets the function that will be called on each stage of the animation.
-                        
-                        Parameters
-                        
-                            f function function that will be called on each stage of animation
-                        
-                        Usage
-                        var p = r.path("M10,50c0,50,80-50,80,0c0,50-80-50-80,0z"),
-    p2 = r.path(),
-    e = r.ellipse(10, 50, 4, 4).attr({stroke: "none", fill: "#f00"}).onAnimation(function () {
-        p2.attr({path: "M50,10L" + e.attr("cx") + "," + e.attr("cy")});
-    }),
-    b = r.rect(0, 0, 620, 400).attr({stroke: "none", fill: "#000", opacity: 0}).click(function () {
-        e.attr({rx: 5, ry: 3}).animateAlong(p, 4000, true, function () {
-            e.attr({rx: 4, ry: 4});
-        });
-    });
-                        
-                            getBBox
-                        
-                        
-                            Returns the dimensions of an element.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-var width = c.getBBox().width;
-                        
-                            toFront
-                        
-                        
-                            Moves the element so it is the closest to the viewerâs eyes, on top of other elements.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.toFront();
-                        
-                            toBack
-                        
-                        
-                            Moves the element so it is the furthest from the viewerâs eyes, behind other elements.
-                        
-                        Usage
-                        var c = paper.circle(10, 10, 10);
-c.toBack();
-                        
-                            insertBefore
-                        
-                        
-                            Inserts current object before the given one.
-                        
-                        Usage
-                        var r = paper.rect(10, 10, 10, 10);
-var c = paper.circle(10, 10, 10);
-c.insertBefore(r);
-                        
-                            insertAfter
-                        
-                        
-                            Inserts current object after the given one.
-                        
-                        Usage
-                        var r = paper.rect(10, 10, 10, 10);
-var c = paper.circle(10, 10, 10);
-r.insertAfter(c);
-                        
-                            clone
-                        
-                        
-                            Returns a clone of the current element.
-                        
-                        Usage
-                        var r = paper.rect(10, 10, 10, 10);
-var c = r.clone();
-                        Graphic Primitives
-                        
-                            Methods of âpaperâ object, created with Raphael function call.
-                        
-                        
-                            raphael
-                        
-                        
-                            Internal reference to Raphael object. In case it is not available.
-                        
-                        Usage
-                        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});
-}
-                        
-                            getTotalLength
-                        
-                        
-                            Path specific method. Returns length of the path in pixels.
-                        
-                        Usage
-                        var p = r.path("M100,100c0,50 100-50 100,0c0,50 -100-50 -100,0z");
-    alert(p.getTotalLength());
-                        
-                            getPointAtLength
-                        
-                        
-                        
-                            Path specific method. Returns point description at given length.
-                        
-                        Parameters
-                        
-                            length number length in pixels from the beginining of the path to the point
-                        
-                        Usage
-                        var p = r.path("M10,50c0,50,80-50,80,0c0,50-80-50-80,0z");
-    var point = p.getPointAtLength(30);
-    r.circle(point.x, point.y, 3);
-                        Returned object format:
-                        
-                            x â x coordinate of the point
-                            y â y coordinate of the point
-                            alpha â angle of the path at the point
-                        
-                        
-                            getSubpath
-                        
-                        
-                        
-                            Path specific method. Returns the subpath string of a given path.
-                        
-                        Parameters
-                        
-                            from number length in pixels from the beginning of the path to the beginning of the subpath
-                            to number length in pixels from the beginning of the path to the end of the subpath
-                        
-                        Usage
-                        var p = r.path("M10,50c0,50,80-50,80,0c0,50-80-50-80,0z");
-    var path = p.getSubpath(10, 60);
-    r.path(path).attr({stroke: "#f00"});
-                        
-                            setSize
-                        
-                        
-                            If you need to change dimensions of the canvas call this method
-                        
-                        Parameters
-                        
-                            width number new width of the canvas
-                            height number new height of the canvas
-                        
-                        
-                            setWindow
-                        
-                        
-                            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 iframe
-                        
-                        Parameters
-                        
-                            window object
-                        
-                        
-                            getRGB
-                        
-                        
-                            Parses passes string and returns an colour object. Especially useful for plug-in developers.
-                        
-                        Parameters
-                        
-                            color string Colour in form acceptable by library
-                        
-                        Usage
-                        var stroke = Raphael.getRGB(circle.attr("stroke")).hex;
-                        
-                            angle
-                        
-                        
-                            Gives you an angle of the line formed by two points or angle between two lines formed by three points.
-                        
-                        Parameters
-                        
-                            x1 number X of the first point
-                            y1 number Y of the first point
-                            x2 number X of the second point
-                            y2 number Y of the second point
-                            x3 number X of the third point [optional]
-                            y3 number Y of the third point [optional]
-                        
-                        Usage
-                        var angle = Raphael.angle(10, 10, 50, 50);
-                        
-                            rad
-                        
-                        
-                            Converts angle to radians.
-                        
-                        Parameters
-                        
-                            deg number value of an angle in degrees
-                        
-                        Usage
-                        var Sin = Math.sin(Raphael.rad(45));
-                        
-                            deg
-                        
-                        
-                            Converts angle to degree.
-                        
-                        Parameters
-                        
-                            rad number value of an angle in radians
-                        
-                        
-                            snapTo
-                        
-                        
-                            Returns a number adjusted to one of various values, if itâs close enough.
-                        
-                        Parameters
-                        
-                            values number or array If values is a number, the value will be snapped to any multiple. If an array, the value will be snapped to the first element thatâs within tolerance.
-                            value number The value to adjust
-                            tolerance number The value must be within tolerance of one of the snap values, or it will be returned unchanged [optional, default 10]
-                        
-                        Usage
-                        // adjust -10..10 to 0, 40..60 to 50, 90-110 to 100, etc
-x = Raphael.snapTo(50, x);
-// adjust 5..35 to 20, 45..75 to 60, otherwise no change
-x = Raphael.snapTo([20, 60], x, 15);
-                        
-                            getColor
-                        
-                        
-                            Returns a colour object for the next colour in spectrum
-                        
-                        Parameters
-                        
-                            value number brightness [optional]
-                        
-                        Usage
-                        var c = paper.path("M10,10L100,100").attr({stroke: Raphael.getColor()});
-                        
-                            getColor.reset
-                        
-                        
-                            Resets getColor function, so it will start from the beginning
-                        
-                        
-                            registerFont
-                        
-                        
-                            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. More about CufÃ³n and how to convert your font form TTF, OTF, etc to JavaScript file. Returns original parameter, so it could be used with chaining.
-                        
-                        Parameters
-                        
-                            font object the font to register
-                        
-                        Usage
-                        Cufon.registerFont(Raphael.registerFont({â¦}))
-                        
-                            getFont
-                        
-                        
-                            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â.
-                        
-                        Parameters
-                        
-                            family string font family name or any word from it
-                            weight string weight of the font [optional]
-                            style string style of the font [optional]
-                            stretch string stretch of the font [optional]
-                        
-                        Usage
-                        paper.print(100, 100, "Test string", paper.getFont("Times", 800), 30);
-                        
-                            print
-                        
-                        
-                        
-                            Creates set of shapes to represent given font at given position with given size. Result of the method is set object (see set) which contains each letter as separate path object.
-                        
-                        Parameters
-                        
-                            x number x position of the text
-                            y number y position of the text
-                            text string text to print
-                            font object font object (see getFont)
-                            font_size number size of the font
-                        
-                        Usage
-                        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"});
-                        
-                            Adding your own methods to canvas
-                        
-                        
-                            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.
-                        
-                        Usage
-                        Raphael.fn.arrow = function (x1, y1, x2, y2, size) {
-    return this.path( ... );
+    anim: // animation object,
+    status: // status
+}, ...]
+
+or
+Returns: object original element if value is specified
+
Element.transform([tstr])⚓➭
+Adds transformation to the element which is separate to other attributes,i.e. translation doesnât change x or y of the rectange. The formatof transformation string is similar to the path string syntax:
+"t100,100r30,100,100s2,2,100,100r45s1.5"
+
+Each letter is a command. There are four commands: t is for translate, r is for rotate, s is forscale and m is for matrix.
+So, example line could be read like âtranslate by 100, 100, rotate 30Â° around 100, 100, scale twice around 100, 100rotate 45Â° around centre and scale 1.5 times relative to centreâ. As you see rotate and scale commands has origincoordinates as a optional parameters.Matrix accepts six parameters.
+Parameters
+
+tstr
+optional
+string
+transformation string
+
+If tstr isnât specified
+Returns: string current transformation string
+else
+Returns: object Element
+
Element.translate(dx, dy)⚓➭
+Adds translation by given amount to the list of transformations of the element.
+Parameters
+
+dx
+number
+horisontal shift
+dy
+number
+vertical shift
+
+Returns: object Element
+
Paper⚓➭
+Paper.bottom⚓➭
+Points to the bottom element on the paper
+
Paper.circle(x, y, r)⚓➭
+Draws a circle.
+Parameters
+
+x
+number
+x coordinate of the centre
+y
+number
+y coordinate of the centre
+r
+number
+radius
+
+Returns: object RaphaÃ«l element object with type âcircleâ
+Usage
+
+var c = paper.circle(50, 50, 40);
+
+
Paper.ellipse(x, y, rx, ry)⚓➭
+Draws an ellipse.
+Parameters
+
+x
+number
+x coordinate of the centre
+y
+number
+y coordinate of the centre
+rx
+number
+horisontal radius
+ry
+number
+vertical radius
+
+Returns: object RaphaÃ«l element object with type âellipseâ
+Usage
+
+var c = paper.ellipse(50, 50, 40, 20);
+
+
Paper.forEach(callback, thisArg)⚓➭
+Executes given function for each element on the paper
+If function returns false it will stop loop running.
+Parameters
+
+callback
+function
+function to run
+thisArg
+object
+context object for the callback
+
+Returns: object Paper object
+
Paper.getById(id)⚓➭
+Returns you element by itâs internal ID.
+Parameters
+
+id
+number
+id
+
+Returns: object RaphaÃ«l element object
+
Paper.getElementByPoint(x, y)⚓➭
+Returns you topmost element under given point.
+Returns: object RaphaÃ«l element object
+Parameters
+
+x
+number
+x coordinate from the top left corner of the window
+y
+number
+y coordinate from the top left corner of the window
+
+Usage
+
+paper.getElementByPoint(mouseX, mouseY).attr({stroke: "#f00"});
+
+
Paper.image(src, x, y, width, height)⚓➭
+Embeds an image into the surface.
+Parameters
+
+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
+
+Returns: object RaphaÃ«l element object with type âimageâ
+Usage
+
+var c = paper.image("apple.png", 10, 10, 80, 80);
+
+
Paper.path(pathString)⚓➭
+Creates a path element by given path data string.
+Parameters
+
+pathString
+string
+path data in SVG path string format.
+
+Returns: object RaphaÃ«l element object with type âellipseâ
+Details of a path's data attribute's format are described in the SVG specification.
+Usage
+
+var c = paper.path("M10 10L90 90");
+// draw a diagonal line:
+// move to 10,10, line to 90,90
+
+
Paper.raphael⚓➭
+Points to the Raphael object/function
+
Paper.rect(x, y, width, height, r)⚓➭
+
+Draws a rectangle.
+Parameters
+
+x
+number
+x coordinate of the top left corner
+y
+number
+y coordinate of the top left corner
+width
+number
+width
+height
+number
+height
+r
+number
+optional radius for rounded corners, default is 0
+
+Returns: object RaphaÃ«l element object with type ârectâ
+Usage
+
+// regular rectangle
+var c = paper.rect(10, 10, 50, 50);
+// rectangle with rounded corners
+var c = paper.rect(40, 40, 50, 50, 10);
+
+
Paper.set()⚓➭
+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.
+Returns: object array-like object that represents set of elements
+Usage
+
+var st = paper.set();
+st.push(
+    paper.circle(10, 10, 5),
+    paper.circle(30, 10, 5)
+);
+st.attr({fill: "red"});
+
+
Paper.setSize(width, height)⚓➭
+If you need to change dimensions of the canvas call this method
+Parameters
+
+width
+number
+new width of the canvas
+height
+number
+new height of the canvas
+
+Usage
+
+var st = paper.set();
+st.push(
+    paper.circle(10, 10, 5),
+    paper.circle(30, 10, 5)
+);
+st.attr({fill: "red"});
+
+
Paper.text(x, y, text)⚓➭
+Draws a text string. If you need line breaks, put â\nâ in the string.
+Parameters
+
+x
+number
+x coordinate position
+y
+number
+y coordinate position
+text
+string
+The text string to draw
+
+Returns: object RaphaÃ«l element object with type âtextâ
+Usage
+
+var t = paper.text(50, 50, "RaphaÃ«l\nkicks\nbutt!");
+
+
Paper.top⚓➭
+Points to the topmost element on the paper
+
Raphael(â¦)⚓➭
+Creates a canvas object on which to draw.You must do this first, as all future calls to drawing methodsfrom this instance will be bound to this canvas.
+Parameters
+
+container
+HTMLElement string
+DOM element or itâs id which is going to be a parent for drawing surface
+width
+number
+ 
+height
+number
+ 
+
+or
+x
+number
+ 
+y
+number
+ 
+width
+number
+ 
+height
+number
+ 
+
+or
+all
+array
+(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>})
+
+or
+onReadyCallback
+function
+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 undefined.
+
+Returns: object Paper
+Usage
+
+// 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"
+}]);
+
+
Raphael.angle(x1, y1, x2, y2, [x3], [y3])⚓➭
+Returns angle between two or three points
+Parameters
+
+x1
+number
+x coord of first point
+y1
+number
+y coord of first point
+x2
+number
+x coord of second point
+y2
+number
+y coord of second point
+x3
+optional
+number
+x coord of third point
+y3
+optional
+number
+y coord of third point
+
+Returns: number angle in degrees.
+
Raphael.animation(params, ms, [easing], [callback])⚓➭
+Creates animation object. That later could be used for Element.animate or Element.animateWith methods.See also Animation.delay and Animation.repeat methods.
+Parameters
+
+params
+object
+final attributes for the element, see also Element.attr
+ms
+number
+number of milliseconds for animation to run
+easing
+optional
+string
+easing type. Accept one of Raphael.easing_formulas or CSS format: cubic-bezier(XX,Â XX,Â XX,Â XX)
+callback
+optional
+function
+callback function. Will be called at the end of animation.
+
+Returns: object Animation
+
Raphael.deg(deg)⚓➭
+Transform angle to degrees
+Parameters
+
+deg
+number
+angle in radians
+
+Returns: number angle in degrees.
+
Raphael.easing_formulas⚓➭
+Object that contains easing formulas for animation. You could extend it with your owns. By default it has following list of easing:
+
+    âlinearâ
+    â<â or âeaseInâ or âease-inâ
+    â>â or âeaseOutâ or âease-outâ
+    â<>â or âeaseInOutâ or âease-in-outâ
+    âbackInâ or âback-inâ
+    âbackOutâ or âback-outâ
+    âelasticâ
+    âbounceâ
+
+See also Easing demo.
+
Raphael.findDotsAtSegment(p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t)⚓➭
+Utility methodFind dot coordinates on the given cubic bezier curve at the given t.
+Parameters
+
+p1x
+number
+x of the first point of the curve
+p1y
+number
+y of the first point of the curve
+c1x
+number
+x of the first anchor of the curve
+c1y
+number
+y of the first anchor of the curve
+c2x
+number
+x of the second anchor of the curve
+c2y
+number
+y of the second anchor of the curve
+p2x
+number
+x of the second point of the curve
+p2y
+number
+y of the second point of the curve
+t
+number
+position on the curve (0..1)
+
+Returns: object point information in format:
+{
+    x: // x coordinate of the point,
+    y: // y coordinate of the point,
+    m: {
+        x: // x coordinate of the left anchor,
+        y: // y coordinate of the left anchor
+    },
+    n: {
+        x: // x coordinate of the right anchor,
+        y: // y coordinate of the right anchor
+    },
+    start: {
+        x: // x coordinate of the start of the curve,
+        y: // y coordinate of the start of the curve
+    },
+    end: {
+        x: // x coordinate of the end of the curve,
+        y: // y coordinate of the end of the curve
+    },
+    alpha: // angle of the curve derivative at the point.
+}
+
+
Raphael.fn⚓➭
+objectYou 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 thisyou need to extend Raphael.fn object. Please note that you can create your own namespacesinside fn object. Methods will be run in context of canvas anyway. You should alter fnobject before RaphaÃ«l instance was created, otherwise it will take no effect.
+Usage
+
+Raphael.fn.arrow = function (x1, y1, x2, y2, size) {
+    return this.path( ... );
 };
-// or create namespace
-Raphael.fn.mystuff = {
-    arrow: function () {â¦},
-    star: function () {â¦},
-    // etcâ¦
+// 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"});
+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();
 
-                        
-                            Adding your own methods to elements
-                        
-                        
-                            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.
-                        
-                        Usage
-                        Raphael.el.red = function () {
-    this.attr({fill: "#f00"});
-};
-// then use it
-paper.circle(100, 100, 20).red();
+
Raphael.getColor([value])⚓➭

+On each call returns next colour in the spectrum. To reset it back to red call Raphael.getColor.reset
+Parameters
+
+value
+optional
+number
+brightness, default is 0.75
+
+Returns: string hex representation of the colour.
+
Raphael.getColor.reset()⚓➭
+Resets spectrum position for Raphael.getColor back to red.
+
Raphael.getPointAtLength(path, length)⚓➭
+Return coordinates of the point located at the given length on the given path.
+Parameters
+
+path
+string
+SVG path string
+length
+number
+ 
+
+Returns: object representation of the point:
+{
+    x: //x coordinate,
+    y: //y coordinate,
+    alpha: //angle of derivative
+}
 
-                        
-                            Custom Attributes
-                        
-                        
-                            If you have a set of attributes that you would like to represent as a function of some number you can do it easily with custom attributes:
-                        
-                        Usage
-                        paper.customAttributes.hue = function (num) {
-    num = num % 1;
-    return {fill: "hsb(" + num + ", .75, 1)"};
-};
-// Custom attribute âhueâ will change fill
-// to be given hue with fixed saturation and brightness.
-// Now you can use it like this:
-var c = paper.circle(10, 10, 10).attr({hue: .45});
-// or even like this:
-c.animate({hue: 1}, 1e3);
-
-// You could also create custom attribute
-// with multiple parameters:
-paper.customAttributes.hsb = function (h, s, b) {
-    return {fill: "hsb(" + [h, s, b].join(",") + ")"};
-};
-c.attr({hsb: ".5 .8 1"});
-c.animate({hsb: "1 0 .5"}, 1e3);
+
Raphael.getRGB(colour)⚓➭

+Parses colour string as RGB object
+Parameters
+
+colour
+string
+colour string in one of formats:
+
+Returns: object RGB object in format:
+{
+    r: // red,
+    g: // green,
+    b: // blue
+    hex: // color in HTML/CSS format: #â¢â¢â¢â¢â¢â¢,
+    error: // true if string canât be parsed
+}
 
-                        
-                            Supported colour formats
-                        
-                        
-                            You could specify colour in this formats:
-                        
-                        
-                            Colour name (âredâ, âgreenâ, âcornflowerblueâ, etc)
-                            #â¢â¢â¢ â shortened HTML colour: (â#000â, â#fc0â, etc)
-                            #â¢â¢â¢â¢â¢â¢ â full length HTML colour: (â#000000â, â#bd2300â)
-                            rgb(â¢â¢â¢, â¢â¢â¢, â¢â¢â¢) â red, green and blue channelsâ values: (ârgb(200, 100, 0)â)
-                            rgb(â¢â¢â¢%, â¢â¢â¢%, â¢â¢â¢%) â same as above, but in %: (ârgb(100%, 175%, 0%)â)
-                            rgba(â¢â¢â¢, â¢â¢â¢, â¢â¢â¢, â¢â¢â¢) â red, green and blue channelsâ values: (ârgba(200, 100, 0, .5)â)
-                            rgba(â¢â¢â¢%, â¢â¢â¢%, â¢â¢â¢%, â¢â¢â¢%) â same as above, but in %: (ârgba(100%, 175%, 0%, 50%)â)
-                            hsb(â¢â¢â¢, â¢â¢â¢, â¢â¢â¢) â hue, saturation and brightness values: (âhsb(0.5, 0.25, 1)â)
-                            hsb(â¢â¢â¢%, â¢â¢â¢%, â¢â¢â¢%) â same as above, but in %
-                            hsba(â¢â¢â¢, â¢â¢â¢, â¢â¢â¢, â¢â¢â¢) â same as above, but with opacity
-                            hsl(â¢â¢â¢, â¢â¢â¢, â¢â¢â¢) â almost the same as hsb, see Wikipedia page
-                            hsl(â¢â¢â¢%, â¢â¢â¢%, â¢â¢â¢%) â same as above, but in %
-                            hsla(â¢â¢â¢, â¢â¢â¢, â¢â¢â¢) â same as above, but with opacity
-                            Optionally for hsb and hsl you could specify hue as a degree: âhsl(240deg, 1, .5)â or, if you want to go fancy, âhsl(240Â°, 1, .5)â
-                        
-                        Usage
-                        paper.circle(100, 100, 20).attr({
-    fill: "hsb(0.6, 1, 0.75)",
-    stroke: "red"
-});
-                        
-                            safari
-                        
-                        
-                            There is an inconvenient rendering bug is Safari (WebKit): sometimes the rendering should be forced. This method should help with dealing with this bug.
-                        
-                        Usage
-                        paper.safari();
-                        
-                            âNinja Modeâ
-                        
-                        
-                            If you want to leave no trace of RaphaÃ«l (Well, RaphaÃ«l creates only one global variable Raphael, but anyway.) You can use ninja method. Beware, that in this case plugins could stop working, because they are depending on global variable existance.
-                        
-                        Usage
-                        (function (local_raphael) {
-    var paper = local_raphael(10, 10, 320, 200);
-    â¦
-})(Raphael.ninja());
+
Raphael.getSubpath(path, from, to)⚓➭

+Return subpath of a given path from given length to given length.
+Parameters
+
+path
+string
+SVG path string
+from
+number
+position of the start of the segment
+to
+number
+position of the end of the segment
+
+Returns: string pathstring for the segment
+
Raphael.getTotalLength(path)⚓➭
+Returns length of the given path in pixels.
+Parameters
+
+path
+string
+SVG path string.
+
+Returns: number length.
+
Raphael.hsb(h, s, b)⚓➭
+Converts HSB values to hex representation of the colour.
+Parameters
+
+h
+number
+hue
+s
+number
+saturation
+b
+number
+value or brightness
+
+Returns: string hex representation of the colour.
+
Raphael.hsb2rgb(h, s, v)⚓➭
+Converts HSB values to RGB object.
+Parameters
+
+h
+number
+hue
+s
+number
+saturation
+v
+number
+value or brightness
+
+Returns: object RGB object in format:
+{
+    r: // red,
+    g: // green,
+    b: // blue
+    hex: // color in HTML/CSS format: #â¢â¢â¢â¢â¢â¢
+}
 
-                        
-                            Events
-                        
-                        
-                            You can attach events to elements by using element.node and your favourite library ($(circle.node).click(â¦)) or you can use built-in methods:
-                        
-                        Usage
-                        element.click(function (event) {
-    this.attr({fill: "red"});
-});
-element.dblclick(function (event) {
-    this.attr({fill: "red"});
-});
-element.mousedown(function (event) {
-    this.attr({fill: "red"});
-});
-element.mousemove(function (event) {
-    this.attr({fill: "red"});
-});
-element.mouseout(function (event) {
-    this.attr({fill: "red"});
-});
-element.mouseover(function (event) {
-    this.attr({fill: "red"});
-});
-element.mouseup(function (event) {
-    this.attr({fill: "red"});
-});
-element.hover(function (event) {
-    this.attr({fill: "red"});
-}, function (event) {
-    this.attr({fill: "black"});
-}, overScope, outScope);
-                        
-                            Second parameter is optional scope. By default handlers are run in the scope of the element. To unbind events use the same method names with âunâ prefix, i.e. element.unclick(f);
-                        
-                        
-                            Drag ânâ Drop
-                        
-                        
-                            To make element âdraggableâ you need to call method drag on element.
-                        
-                        Parameters
-                        
-                            onmove function event handler for moving
-                            onstart function event handler for start
-                            onend function event handler for end of the drag
-                        
-                        Usage
-                        var c = R.circle(100, 100, 50).attr({
-    fill: "hsb(.8, 1, 1)",
-    stroke: "none",
-    opacity: .5
-});
-var start = function () {
-    // storing original coordinates
-    this.ox = this.attr("cx");
-    this.oy = this.attr("cy");
-    this.attr({opacity: 1});
-},
-move = function (dx, dy) {
-    // move will be called with dx and dy
-    this.attr({cx: this.ox + dx, cy: this.oy + dy});
-},
-up = function () {
-    // restoring state
-    this.attr({opacity: .5});
-};
-c.drag(move, start, up);
-                        
-                            To unbind drag use the undrag method.
-                        
-                    
-                    
-                        
-                            Home
-                        
-                        
-                            Contents
-                        
-                        
-                            
-                                Raphael
-                            
-                            
-                                circle
-                            
-                            
-                                rect
-                            
-                            
-                                ellipse
-                            
-                            
-                                image
-                            
-                            
-                                set
-                            
-                            
-                                text
-                            
-                            
-                                path
-                            
-                            
-                                clear
-                            
-                            
-                                node
-                            
-                            
-                                paper
-                            
-                            
-                                remove
-                            
-                            
-                                hide
-                            
-                            
-                                show
-                            
-                            
-                                rotate
-                            
-                            
-                                translate
-                            
-                            
-                                scale
-                            
-                            
-                                attr
-                            
-                            
-                                animate
-                            
-                            
-                                animateWith
-                            
-                            
-                                animateAlong
-                            
-                            
-                                animateAlongBack
-                            
-                            
-                                getBBox
-                            
-                            
-                                toFront
-                            
-                            
-                                toBack
-                            
-                            
-                                insertBefore
-                            
-                            
-                                insertAfter
-                            
-                            
-                                clone
-                            
-                            
-                                raphael
-                            
-                            
-                                getTotalLength
-                            
-                            
-                                getPointAtLength
-                            
-                            
-                                getSubpath
-                            
-                            
-                                setSize
-                            
-                            
-                                setWindow
-                            
-                            
-                                getRGB
-                            
-                            
-                                angle
-                            
-                            
-                                rad
-                            
-                            
-                                deg
-                            
-                            
-                                snapTo
-                            
-                            
-                                getColor
-                            
-                            
-                                getColor.reset
-                            
-                            
-                                registerFont
-                            
-                            
-                                getFont
-                            
-                            
-                                print
-                            
-                            
-                                Adding your own methods to canvas
-                            
-                            
-                                Adding your own methods to elements
-                            
-                            
-                                Custom Attributes
-                            
-                            
-                                Supported colour formats
-                            
-                            
-                                safari
-                            
-                            
-                                âNinja Modeâ
-                            
-                            
-                                Events
-                            
-                        
-                    
-                    
-                        
-                            Some Rights Reserved by Dmitry Baranovskiy
-                        
-                        
-                            Logo by Wasabicube
-                        
-                    
-        

-        
-        
-        
-        
-        
-        
-    
-
+

`Raphael.hsl(h, s, l)⚓➭`


+Converts HSL values to hex representation of the colour.
+Parameters
+
+h
+number
+hue
+s
+number
+saturation
+l
+number
+luminosity
+
+Returns: string hex representation of the colour.
+
Raphael.hsl2rgb(h, s, l)⚓➭
+Converts HSL values to RGB object.
+Parameters
+
+h
+number
+hue
+s
+number
+saturation
+l
+number
+luminosity
+
+Returns: object RGB object in format:
+{
+    r: // red,
+    g: // green,
+    b: // blue
+    hex: // color in HTML/CSS format: #â¢â¢â¢â¢â¢â¢
+}
+
+
Raphael.is(o, type)⚓➭
+Handfull replacement for typeof operator.
+Parameters
+
+o
+â¦
+any object or primitive
+type
+string
+name of the type, i.e. âstringâ, âfunctionâ, ânumberâ, etc.
+
+Returns: boolean is given value is of given type
+
Raphael.parsePathString(pathString)⚓➭
+Utility methodParses given path string into an array of arrays of path segments.
+Parameters
+
+pathString
+string array
+path string or array of segments (in the last case it will be returned stright away)
+
+Returns: array array of segments.
+
Raphael.parseTransformString(TString)⚓➭
+Utility methodParses given path string into an array of transformations.
+Parameters
+
+TString
+string array
+transform string or array of transformations (in the last case it will be returned stright away)
+
+Returns: array array of transformations.
+
Raphael.path2curve(pathString)⚓➭
+Utility methodConverts path to path where all segments are cubic bezier curves.
+Parameters
+
+pathString
+string array
+path string or array of segments
+
+Returns: array array of segments.
+
Raphael.pathToRelative(pathString)⚓➭
+Utility methodConverts path to relative form
+Parameters
+
+pathString
+string array
+path string or array of segments
+
+Returns: array array of segments.
+
Raphael.rad(deg)⚓➭
+Transform angle to radians
+Parameters
+
+deg
+number
+angle in degrees
+
+Returns: number angle in radians.
+
Raphael.rgb(r, g, b)⚓➭
+Converts RGB values to hex representation of the colour.
+Parameters
+
+r
+number
+red
+g
+number
+green
+b
+number
+blue
+
+Returns: string hex representation of the colour.
+
Raphael.rgb2hsb(r, g, b)⚓➭
+Converts RGB values to HSB object.
+Parameters
+
+r
+number
+red
+g
+number
+green
+b
+number
+blue
+
+Returns: object HSB object in format:
+{
+    h: // hue,
+    s: // saturation,
+    b: // brightness
+}
+
+
Raphael.rgb2hsl(r, g, b)⚓➭
+Converts RGB values to HSL object.
+Parameters
+
+r
+number
+red
+g
+number
+green
+b
+number
+blue
+
+Returns: object HSL object in format:
+{
+    h: // hue,
+    s: // saturation,
+    l: // luminosity
+}
+
+
Raphael.setWindow(newwin)⚓➭
+Used when you need to draw in <iframe>. Switched window to the iframe one.
+Parameters
+
+newwin
+window
+new window object
+
+
Raphael.snapTo(values, value, [tolerance])⚓➭
+Snaps given value to given grid.
+Parameters
+
+values
+array number
+given array of values or step of the grid
+value
+number
+value to adjust
+tolerance
+optional
+number
+tolerance for snapping. Default is 10.
+
+Returns: number adjusted value.
+
Raphael.svg⚓➭
+booleantrue if browser supports SVG.
+
Raphael.type⚓➭
+stringCan be âSVGâ, âVMLâ or empty, depending on browser support.
+
Raphael.vml⚓➭
+booleantrue if browser supports VML.
+

RaphaÃ«lâJavaScript Library

Main Function

- Raphael -

Parameters

Usage

RaphaÃ«l Reference

Animation⚓➭

Animation.delay(delay)⚓➭

Animation.repeat(repeat)⚓➭

Element⚓➭

Element.animate(â¦)⚓➭

Element.clone()⚓➭

Element.getBBox(isWithoutTransform)⚓➭

Element.getPointAtLength(length)⚓➭

Element.getSubpath(from, to)⚓➭

Element.getTotalLength()⚓➭

Element.glow()⚓➭

Element.rotate(deg, [cx], [cy])⚓➭

Element.scale(sx, sy, [cx], [cy])⚓➭

Element.setTime(anim, value)⚓➭

Element.status([anim], [value])⚓➭

- circle -

Parameters

Usage

- rect -

Parameters

Usage

- ellipse -

Parameters

Usage

- image -

Parameters

Usage

- set -

Usage

- text -

Parameters

Usage

- path -

Parameters

Usage

- clear -

Usage

- Elementâs generic methods -

- node -

Usage

- paper -

Usage

- remove -

Usage

- hide -

Usage

- show -

Usage

- rotate -

Parameters

Usage

- translate -

Parameters

Usage

- scale -

Parameters

Usage

- attr -

Parameters

Possible parameters

Usage

- animate -

Parameters

Attributes that can be animated

Easing

Usage

- animateWith -

Parameters

Usage

- animateAlong -

Parameters

Usage

- animateAlongBack -

- onAnimation -

RaphaÃ«lâJavaScript Library

Element.animate(â¦)⚓➭

- Elementâs generic methods -