From 6a013f19d6fa84e538d31bca5f1466c5f3479630 Mon Sep 17 00:00:00 2001 From: wout Date: Mon, 17 Dec 2012 16:55:16 +0100 Subject: [PATCH] Refactored code for readability and size --- Rakefile | 2 +- dist/svg.js | 459 ++++++++++++++++++++++++++--------------------- dist/svg.min.js | 4 +- src/circle.js | 47 ++--- src/clip_path.js | 6 +- src/container.js | 4 +- src/defs.js | 24 ++- src/document.js | 17 +- src/element.js | 194 ++++++++++---------- src/ellipse.js | 45 ++--- src/group.js | 21 ++- src/image.js | 21 ++- src/object.js | 40 +++-- src/path.js | 17 +- src/rect.js | 2 +- src/shape.js | 53 +++--- src/svg.js | 12 +- src/utils.js | 10 ++ 18 files changed, 551 insertions(+), 427 deletions(-) create mode 100644 src/utils.js diff --git a/Rakefile b/Rakefile index f2df30e..7fdd118 100644 --- a/Rakefile +++ b/Rakefile @@ -1,6 +1,6 @@ SVGJS_VERSION = '0.1' -DEFAULT_MODULES = %w[ svg container object element document defs shape rect circle ellipse path image group clip_path ] +DEFAULT_MODULES = %w[ svg utils container element document defs shape rect circle ellipse path image group clip_path ] KILO = 1024 # how many bytes in a "kilobyte" diff --git a/dist/svg.js b/dist/svg.js index 63c8780..feea266 100644 --- a/dist/svg.js +++ b/dist/svg.js @@ -1,16 +1,27 @@ -/* svg.js 0.1 - svg container object element document defs shape rect circle ellipse path image group clip_path - svgjs.com/license */ +/* svg.js 0.1 - svg utils container element document defs shape rect circle ellipse path image group clip_path - svgjs.com/license */ (function() { - var SVG = { - namespace: "http://www.w3.org/2000/svg", - xlink: "http://www.w3.org/1999/xlink", + this.SVG = { + ns: 'http://www.w3.org/2000/svg', + xlink: 'http://www.w3.org/1999/xlink', - createElement: function(e) { - return document.createElementNS(this.namespace, e); + create: function(e) { + return document.createElementNS(this.ns, e); } }; - this.SVG = SVG; + this.svg = function(e) { + return new SVG.Document(e); + }; + + SVG.Utils = { + + merge: function(o, m) { + for (var k in m) + o.prototype[k] = m[k]; + } + + }; SVG.Container = { @@ -22,7 +33,7 @@ if (!this.contains(e)) { i = i == null ? this.children().length : i; this.children().splice(i, 0, e); - this.svgElement.insertBefore(e.svgElement, this.svgElement.childNodes[i + 1]); + this.node.insertBefore(e.node, this.node.childNodes[i + 1]); e.parent = this; } @@ -71,7 +82,7 @@ if (0 <= i && i < this.children().length) { var e = this.children()[i]; this.children().splice(i, 1); - this.svgElement.removeChild(e.svgElement); + this.node.removeChild(e.node); e.parent = null; } @@ -158,150 +169,153 @@ }; - Object.prototype.include = function(module) { - - for (var key in module) - this.prototype[key] = module[key]; - - if (module.included != null) - module.included.apply(this); - - return this; - }; - - SVG.Element = function Element(svgElement) { - this.svgElement = svgElement; - this.attributes = {}; + SVG.Element = function Element(node) { + this.node = node; + this.attrs = {}; }; - //-D // inherit from SVG.Object - //-D SVG.Element.prototype = new SVG.Object(); - - // move element to given x and y values - SVG.Element.prototype.move = function(x, y) { - this.setAttribute('x', x); - this.setAttribute('y', y); + // Add element-specific functions + SVG.Utils.merge(SVG.Element, { - return this; - }; + // move element to given x and y values + move: function(x, y) { + this.attr('x', x); + this.attr('y', y); - // set element opacity - SVG.Element.prototype.opacity = function(o) { - return this.setAttribute('opacity', Math.max(0, Math.min(1, o))); - }; + return this; + }, - // set element size to given width and height - SVG.Element.prototype.size = function(w, h) { - this.setAttribute('width', w); - this.setAttribute('height', h); - - return this; - }; + // set element opacity + opacity: function(o) { + return this.attr('opacity', Math.max(0, Math.min(1, o))); + }, - // clip element using another element - SVG.Element.prototype.clip = function(block) { - var p = this.parentSVG().defs().clipPath(); - block(p); - - return this.clipTo(p); - }; + // set element size to given width and height + size: function(w, h) { + this.attr('width', w); + this.attr('height', h); - // distribute clipping path to svg element - SVG.Element.prototype.clipTo = function(p) { - return this.setAttribute('clip-path', 'url(#' + p.id + ')'); - }; + return this; + }, - // remove element - SVG.Element.prototype.destroy = function() { - return this.parent != null ? this.parent.remove(this) : void 0; - }; + // clip element using another element + clip: function(block) { + var p = this.parentSVG().defs().clipPath(); + block(p); - // get parent document - SVG.Element.prototype.parentDoc = function() { - return this._findParent(SVG.Document); - }; + return this.clipTo(p); + }, - // get parent svg wrapper - SVG.Element.prototype.parentSVG = function() { - return this.parentDoc(); - }; + // distribute clipping path to svg element + clipTo: function(p) { + return this.attr('clip-path', 'url(#' + p.id + ')'); + }, - // set svg element attribute - SVG.Element.prototype.setAttribute = function(a, v, ns) { - this.attributes[a] = v; - - if (ns != null) - this.svgElement.setAttributeNS(ns, a, v); - else - this.svgElement.setAttribute(a, v); - - return this; - }; + // remove element + destroy: function() { + return this.parent != null ? this.parent.remove(this) : void 0; + }, - // set svg element attribute - SVG.Element.prototype.attr = function(v) { - if (typeof v == 'object') - for (var k in v) - this.setAttribute(k, v[k]); - else if (arguments.length == 2) - this.setAttribute(arguments[0], arguments[1]); - - return this; - }; + // get parent document + parentDoc: function() { + return this._parent(SVG.Document); + }, - // get bounding box - SVG.Element.prototype.getBBox = function() { - return this.svgElement.getBBox(); - }; + // get parent svg wrapper + parentSVG: function() { + return this.parentDoc(); + }, - // private: find svg parent - SVG.Element.prototype._findParent = function(pt) { - var e = this; - - while (e != null && !(e instanceof pt)) - e = e.parent; - - return e; - }; + //_D // set svg element attribute + //_D setAttribute: function(a, v, ns) { + //_D this.attrs[a] = v; + //_D + //_D if (ns != null) + //_D this.node.setAttributeNS(ns, a, v); + //_D else + //_D this.node.setAttribute(a, v); + //_D + //_D return this; + //_D }, + + // set svg element attribute + attr: function(v) { + var a = arguments; + + this.attrs[a[0]] = a[1]; + + if (typeof v == 'object') + for (var k in v) + this.attr(k, v[k]); + + else if (a.length == 2) + this.node.setAttribute(a[0], a[1]); + + else if (a.length == 3) + this.node.setAttributeNS(a[2], a[0], a[1]); + + return this; + }, + // get bounding box + bbox: function() { + return this.node.getBBox(); + }, + // private: find svg parent + _parent: function(pt) { + var e = this; + while (e != null && !(e instanceof pt)) + e = e.parent; + return e; + } + + }); - SVG.Document = function Document(c) { - this.constructor.call(this, SVG.createElement('svg')); + SVG.Document = function Document(e) { + this.constructor.call(this, SVG.create('svg')); - this.setAttribute('xmlns', SVG.namespace); - this.setAttribute('version', '1.1'); - this.setAttribute('xlink', 'http://www.w3.org/1999/xlink', SVG.namespace); + this.attr('xmlns', SVG.ns); + this.attr('version', '1.1'); + this.attr('xlink', SVG.xlink, SVG.ns); - document.getElementById(c).appendChild(this.svgElement); + if (typeof e == 'string') + e = document.getElementById(e); + + e.appendChild(this.node); }; // inherit from SVG.Element SVG.Document.prototype = new SVG.Element(); // include the container object - SVG.Document.include(SVG.Container); + SVG.Utils.merge(SVG.Document, SVG.Container); SVG.Defs = function Defs() { - this.constructor.call(this, SVG.createElement('defs')); + this.constructor.call(this, SVG.create('defs')); }; // inherit from SVG.Element SVG.Defs.prototype = new SVG.Element(); - // define clippath - SVG.Defs.prototype.clipPath = function() { - var e = new SVG.ClipPath(); - this.add(e); + // include the container object + SVG.Utils.merge(SVG.Defs, SVG.Container); + + // Add def-specific functions + SVG.Utils.merge(SVG.Defs, { - return e; - }; + // define clippath + clipPath: function() { + var e = new SVG.ClipPath(); + this.add(e); - // include the container object - SVG.Defs.include(SVG.Container); + return e; + } + + }); SVG.Shape = function Shape(element) { this.constructor.call(this, element); @@ -310,160 +324,191 @@ // inherit from SVG.Element SVG.Shape.prototype = new SVG.Element(); - // set fill color and opacity - SVG.Shape.prototype.fill = function(fill) { - if (fill.color != null) - this.setAttribute('fill', fill.color); + // Add shape-specific functions + SVG.Utils.merge(SVG.Shape, { - if (fill.opacity != null) - this.setAttribute('fill-opacity', fill.opacity); - - return this; - }; + // set fill color and opacity + fill: function(fill) { + if (fill.color != null) + this.attr('fill', fill.color); - // set stroke color and opacity - SVG.Shape.prototype.stroke = function(stroke) { - if (stroke.color != null) - this.setAttribute('stroke', stroke.color); - - if (stroke.width != null) - this.setAttribute('stroke-width', stroke.width); - - if (stroke.opacity != null) - this.setAttribute('stroke-opacity', stroke.opacity); - - if (this.attributes['fill-opacity'] == null) - this.fill({ opacity: 0 }); + if (fill.opacity != null) + this.attr('fill-opacity', fill.opacity); + + return this; + }, + + // set stroke color and opacity + stroke: function(stroke) { + if (stroke.color != null) + this.attr('stroke', stroke.color); + + if (stroke.width != null) + this.attr('stroke-width', stroke.width); + + if (stroke.opacity != null) + this.attr('stroke-opacity', stroke.opacity); + + if (this.attrs['fill-opacity'] == null) + this.fill({ opacity: 0 }); + + return this; + } - return this; - }; + }); SVG.Rect = function Rect() { - this.constructor.call(this, SVG.createElement('rect')); + this.constructor.call(this, SVG.create('rect')); }; // inherit from SVG.Shape SVG.Rect.prototype = new SVG.Shape(); SVG.Circle = function Circle() { - this.constructor.call(this, SVG.createElement('circle')); + this.constructor.call(this, SVG.create('circle')); }; // inherit from SVG.Shape SVG.Circle.prototype = new SVG.Shape(); - // custom move function - SVG.Circle.prototype.move = function(x, y) { - this.attributes.x = x; - this.attributes.y = y; - this.center(); + // Add circle-specific functions + SVG.Utils.merge(SVG.Circle, { - return this; - }; + // custom move function + move: function(x, y) { + this.attrs.x = x; + this.attrs.y = y; + this.center(); - // custom size function - SVG.Circle.prototype.size = function(w, h) { - this.setAttribute('r', w / 2); - this.center(); - - return this; - }; + return this; + }, - // private: center - SVG.Circle.prototype.center = function(cx, cy) { - var r = this.attributes.r || 0; + // custom size function + size: function(w, h) { + this.attr('r', w / 2); + this.center(); + + return this; + }, + + // private: center + center: function(cx, cy) { + var r = this.attrs.r || 0; + + this.attr('cx', cx || ((this.attrs.x || 0) + r)); + this.attr('cy', cy || ((this.attrs.y || 0) + r)); + } - this.setAttribute('cx', cx || ((this.attributes.x || 0) + r)); - this.setAttribute('cy', cy || ((this.attributes.y || 0) + r)); - }; + }); SVG.Ellipse = function Ellipse() { - this.constructor.call(this, SVG.createElement('ellipse')); + this.constructor.call(this, SVG.create('ellipse')); }; // inherit from SVG.Shape SVG.Ellipse.prototype = new SVG.Shape(); - // custom move function - SVG.Ellipse.prototype.move = function(x, y) { - this.attributes.x = x; - this.attributes.y = y; - this.center(); + // Add ellipse-specific functions + SVG.Utils.merge(SVG.Ellipse, { - return this; - }; + // custom move function + move: function(x, y) { + this.attrs.x = x; + this.attrs.y = y; + this.center(); - // custom size function - SVG.Ellipse.prototype.size = function(w, h) { - this.setAttribute('rx', w / 2); - this.setAttribute('ry', h / 2); - this.center(); - - return this; - }; + return this; + }, - SVG.Ellipse.prototype.center = function(cx, cy) { - this.setAttribute('cx', cx || ((this.attributes.x || 0) + (this.attributes.rx || 0))); - this.setAttribute('cy', cy || ((this.attributes.y || 0) + (this.attributes.ry || 0))); - }; + // custom size function + size: function(w, h) { + this.attr('rx', w / 2); + this.attr('ry', h / 2); + this.center(); + + return this; + }, + + center: function(cx, cy) { + this.attr('cx', cx || ((this.attrs.x || 0) + (this.attrs.rx || 0))); + this.attr('cy', cy || ((this.attrs.y || 0) + (this.attrs.ry || 0))); + } + + }); + SVG.Path = function Path() { - this.constructor.call(this, SVG.createElement('path')); + this.constructor.call(this, SVG.create('path')); }; // inherit from SVG.Shape SVG.Path.prototype = new SVG.Shape(); - // set path data - SVG.Path.prototype.data = function(d) { - this.setAttribute('d', d); - return this; - }; + // Add path-specific functions + SVG.Utils.merge(SVG.Path, { + + // set path data + data: function(d) { + this.attr('d', d); + return this; + } + + }); SVG.Image = function Image() { - this.constructor.call(this, SVG.createElement('image')); + this.constructor.call(this, SVG.create('image')); }; // inherit from SVG.Element SVG.Image.prototype = new SVG.Element(); - // (re)load image - SVG.Image.prototype.load = function(url) { - this.setAttribute('href', url, SVG.xlink); - return this; - }; - // include the container object - SVG.Image.include(SVG.Container); + SVG.Utils.merge(SVG.Image, SVG.Container); + + // Add image-specific functions + SVG.Utils.merge(SVG.Image, { + + // (re)load image + load: function(u) { + this.attr('href', u, SVG.xlink); + return this; + } + + }); SVG.Group = function Group() { - this.constructor.call(this, SVG.createElement("g")); + this.constructor.call(this, SVG.create('g')); }; // inherit from SVG.Element SVG.Group.prototype = new SVG.Element(); - // group rotation - SVG.Group.prototype.rotate = function(d) { - this.setAttribute('transform', 'rotate(' + d + ')'); - return this; - }; - // include the container object - SVG.Group.include(SVG.Container); + SVG.Utils.merge(SVG.Group, SVG.Container); + + // Add group-specific functions + SVG.Utils.merge(SVG.Group, { + + // group rotation + rotate: function(d) { + this.attr('transform', 'rotate(' + d + ')'); + return this; + } + + }); var clipID = 0; SVG.ClipPath = function ClipPath() { - this.constructor.call(this, SVG.createElement('clipPath')); + this.constructor.call(this, SVG.create('clipPath')); this.id = '_' + (clipID++); - this.setAttribute('id', this.id); + this.attr('id', this.id); }; // inherit from SVG.Element SVG.ClipPath.prototype = new SVG.Element(); // include the container object - SVG.ClipPath.include(SVG.Container); + SVG.Utils.merge(SVG.ClipPath, SVG.Container); }).call(this); diff --git a/dist/svg.min.js b/dist/svg.min.js index ee616ba..cc7eb88 100644 --- a/dist/svg.min.js +++ b/dist/svg.min.js @@ -1,2 +1,2 @@ -/* svg.js 0.1 - svg container object element document defs shape rect circle ellipse path image group clip_path - svgjs.com/license */ -(function(){var e={namespace:"http://www.w3.org/2000/svg",xlink:"http://www.w3.org/1999/xlink",createElement:function(e){return document.createElementNS(this.namespace,e)}};this.SVG=e,e.Container={add:function(e){return this.addAt(e)},addAt:function(e,t){return this.contains(e)||(t=t==null?this.children().length:t,this.children().splice(t,0,e),this.svgElement.insertBefore(e.svgElement,this.svgElement.childNodes[t+1]),e.parent=this),this},contains:function(e){return Array.prototype.indexOf.call(this.children(),e)>=0},children:function(){return this._children||[]},sendBack:function(e){var t=this.children().indexOf(e);if(t!==-1)return this.remove(e).addAt(e,t-1)},bringForward:function(e){var t=this.children().indexOf(e);if(t!==-1)return this.remove(e).addAt(e,t+1)},bringToFront:function(e){return this.contains(e)&&this.remove(e).add(e),this},sendToBottom:function(e){return this.contains(e)&&this.remove(e).addAt(e,0),this},remove:function(e){return this.removeAt(this.children().indexOf(e))},removeAt:function(e){if(0<=e&&e=0},children:function(){return this._children||[]},sendBack:function(e){var t=this.children().indexOf(e);if(t!==-1)return this.remove(e).addAt(e,t-1)},bringForward:function(e){var t=this.children().indexOf(e);if(t!==-1)return this.remove(e).addAt(e,t+1)},bringToFront:function(e){return this.contains(e)&&this.remove(e).add(e),this},sendToBottom:function(e){return this.contains(e)&&this.remove(e).addAt(e,0),this},remove:function(e){return this.removeAt(this.children().indexOf(e))},removeAt:function(e){if(0<=e&&e