Names of the easing RaphaelBuiltinEasingFormulas that are available by default. See also the RaphaelStatic.easing_formulas object.
Array that can be passed to the Raphael() constructor. The first three arguments in the array are, in order:
containerID: ID of the element which is going to be a parent for drawing surface.width: Width for the canvas.height: Height for the canvas.The remaining items are descriptor objects for the shapes that are created initially.
Array that can be passed to the Raphael() constructor. The first four arguments in the array are, in order:
x: x coordinate of the viewport where the canvas is created.y: y coordinate of the viewport where the canvas is created.width: Width for the canvas.height: Height for the canvas.The remaining items are descriptor objects for the shapes that are created initially.
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, see RaphaelPaper.customAttributes for more details.
Names of the easing RaphaelBuiltinEasingFormulas that may be added by the user. See also the RaphaelStatic.easing_formulas object.
Represents the stroke dash types supported by Raphaël.
Represents the handler callback that is called when dragging ends. See RaphaelBaseElement.drag.
Represents the handler callback that is called when the pointer is moved while dragging. See RaphaelBaseElement.drag.
Represents an event handler for when the pointer moves over another element while dragging. See also RaphaelBaseElement.onDragOver.
Represents the handler callback that is called when dragging starts. See RaphaelBaseElement.drag.
An easing formula for smoothly interpolating between two values. The formula is passed the normalized animation time and should return the relative animation position at that time.
You can add your own method to elements, see RaphaelStatic.el for more details.
Plugin methods may take any arbitrary number of parameters and may return any value. When possible, consider
return this to allow for chaining.
You can add your own method to elements. This is useful when you want to hack default functionality or want to wrap some common transformation or attributes in one method. In contrast to canvas methods, you can redefine element method at any time. Expending element methods would not affect set.
Raphael.el.red = function () {
this.attr({fill: "#f00"});
};
// then use it
paper.circle(100, 100, 20).red();
Represents the base line of a piece of text.
Represents the line cap types supported by Raphaël. See RaphaelBaseElement.attr.
Represents the line join types supported by Raphaël. See RaphaelBaseElement.attr.
Callback that is invoked once an animation is complete.
You can add your own method to the canvas, see RaphaelStatic.fn for more details.
Plugin methods may take any arbitrary number of parameters and may return any value. When possible, consider
return this to allow for chaining.
You can add your own method to the canvas. Please note that you can create your own namespaces inside the RaphaelStatic.fn object - methods will be run in the context of canvas anyway:
Raphael.fn.arrow = function (x1, y1, x2, y2, size) {
return this.path( ... );
};
// 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();
Represents a single command of an SVG path string, such as a moveto or lineto command.
Please note that Raphaël splits path strings such as H 10 20 into two segments: ["H", 10] and ["H", 20].
Represents a result or return value of an operation that can fail, such as due to illegal arguments. For example, RaphaelStatic.getRGB returns an error if the string could not be parsed.
This adds an error property. When it is set to to true, the operation was not successful - such as when an
input string could not be parsed or the arguments are out of range.
You can add your own method to set, see RaphaelStatic.st for more details.
Plugin methods may take any arbitrary number of parameters and may return any value. When possible, consider
return this to allow for chaining.
You can add your own method to elements and sets. It is wise to add a set method for each element method you added, so you will be able to call the same method on sets too. See also {@link el}.
Raphael.el.red = function() {
this.attr({fill: "#f00"});
};
Raphael.st.red = function() {
this.forEach(function () {
this.red();
});
};
// then use it
paper.set(paper.circle(100, 100, 20), paper.circle(110, 100, 20)).red();
Represents the technology used by Raphaël, depending on the browser support.
SVG: Scalable vector graphics are used.VML: Vector markup language is used.(empty string): Neither technology can be used. Raphaël will not work.Vector Markup Language (VML) was an XML-based file format for two-dimensional vector graphics. It was specified in Part 4 of the Office Open XML standards ISO/IEC 29500 and ECMA-376. According to the specification, VML is a deprecated format included in Office Open XML for legacy reasons only.
Represents the text anchor types supported by Raphaël. See RaphaelBaseElement.attr.
Represents a single transform operation:
t: A translation operation. Parameters are [deltaX, deltaY]s: A scaling operation. Parameters are [scaleX, scaleY, originX, originY]r: A rotation operation: Parameters are [angleInDegrees, originX, originY]m: A general matrix transform. Parameters are [a, b, c, d, e, f], see RaphaelMatrix.Distinguishes between a RaphaelSet and other RaphaelElements. When an event handler is added to a set, it is called with the this context set to the elements contained in the set. Otherwise, when the handler is added to an element, it is called with the this context set to that element.
Dummy type alias for a VML circle element. Might be replaced with the actual API at some point.
Dummy type alias for a VML element (vector markup language). Might be replaced with the actual API at some point.
Vector Markup Language (VML) was an XML-based file format for two-dimensional vector graphics. It was specified in Part 4 of the Office Open XML standards ISO/IEC 29500 and ECMA-376. According to the specification, VML is a deprecated format included in Office Open XML for legacy reasons only.
Dummy type alias for a VML ellipse element. Might be replaced with the actual API at some point.
Dummy type alias for a VML image element. Might be replaced with the actual API at some point.
Dummy type alias for a VML path element. Might be replaced with the actual API at some point.
Dummy type alias for a VML rect element. Might be replaced with the actual API at some point.
Dummy type alias for a VML text element. Might be replaced with the actual API at some point.
Generated using TypeDoc
A basic event handler for some common events on RaphaelElements, such as
clickanddblclick.