Documentation (not complete).

This commit is contained in:
Antoine Nguyen
2014-02-16 14:53:18 +01:00
parent 2642d78115
commit 6e94a5bca2
2 changed files with 250 additions and 190 deletions
@@ -1,145 +1,126 @@
/*
*
/**
* Creates an instance of ModoChart.
*
* @constructor
* @this {ModoChart}
* @param {string} selection add chart to this DOM element.
*
*/
var Graphic = function(selector, data, options) {
this.initialize(selector, data, options);
};
Graphic.prototype = {
constructor: Graphic,
defaults: {
height: 300,
preview_height: 80,
brush_height: 7,
margin: {
function ModoChart(selection) {
var width = 0,
height = 300,
preview_height = 80,
brush_height = 7,
margin = {
left: 50,
top: 10,
bottom: 20
}
},
};
var container;
initialize: function(selector, data, options) {
this.options = $.extend({}, this.defaults, options);
this.selector = selector;
this.data = data;
$(window).resize($.proxy(this.resize, this));
this.render();
},
resize: function() {
this.remove();
this.render();
},
remove: function() {
this.container.select("svg").remove();
$(this.container[0][0]).empty();
},
height: function() {
return this.options.height + 2 * this.options.margin.top
+ 2 * this.options.margin.bottom + this.options.preview_height
+ this.options.brush_height;
},
render: function() {
var $element = $(this.selector);
var width = $element.width();
this.container = d3.select(this.selector)
/**
* Create and render the chart.
*
* @this {ModoChart}
* @param {Object} data chart's data.
*/
function my(data) {
container = d3.select(selection)
.append("div")
.attr("class", "chart");
this.container.append("h6")
.html(this.data.title);
var svg = this.container
container.append("h6").html(data.title);
width = $(selection).width();
var svg = container
.append("svg")
.attr("width", width)
.attr("height", this.height());
.attr("height", my.totalHeight());
svg.append("defs").append("clipPath")
.attr("id", "clip")
.append("rect")
.attr("width", width - 2 * this.options.margin.left)
.attr("height", this.options.height + 30);
var x = d3.time.scale().range([0, width - 2 * this.options.margin.left]),
x2 = d3.time.scale().range([0, width - 2 * this.options.margin.left]);
.attr("width", width - 2 * margin.left)
.attr("height", height + margin.top + margin.bottom);
var x = d3.time.scale().range([0, width - 2 * margin.left]),
x2 = d3.time.scale().range([0, width - 2 * margin.left]);
var xAxis = d3.svg.axis().scale(x).orient("bottom"),
xAxis2 = d3.svg.axis().scale(x2).orient("bottom");
var y = d3.scale.linear().range([this.options.height, 0]),
y2 = d3.scale.linear().range([this.options.preview_height, 0]);
var y = d3.scale.linear().range([height, 0]),
y2 = d3.scale.linear().range([preview_height, 0]);
var yAxis = d3.svg.axis().scale(y).orient("left");
var bisectDate = d3.bisector(function(d) { return d.x * 1000; }).left;
var brush = d3.svg.brush()
.x(x2)
.on("brush", brushed);
var points = [];
x.domain(d3.extent(this.data.curves[0].data.map(function(d) { return d.x * 1000; })));
y.domain([
d3.min(this.data.curves, function(d) { return d3.min(d.data, function(v) { return v.y; }); }),
d3.max(this.data.curves, function(d) { return d3.max(d.data, function(v) { return v.y; }); })
]);
x.domain(
d3.extent(data.curves[0].data.map(function(d) { return d.x * 1000; }))
);
y.domain(
[d3.min(data.curves, function(d) { return d3.min(d.data, function(v) { return v.y; }); }),
d3.max(data.curves, function(d) { return d3.max(d.data, function(v) { return v.y; }); })
]
);
x2.domain(x.domain());
y2.domain(y.domain());
var yAxis = d3.svg.axis().scale(y).orient("left");
var area = d3.svg.area()
.interpolate("monotone")
.x(function(d) { return x(d.x * 1000); })
.y0(this.options.height)
.y0(height)
.y1(function(d) { return y(d.y); });
var area2 = d3.svg.area()
.interpolate("monotone")
.x(function(d) { return x2(d.x * 1000); })
.y0(this.options.preview_height)
.y0(preview_height)
.y1(function(d) { return y2(d.y); });
var focus = svg.append("g")
.attr("class", "focus")
.attr("width", width - 2 * this.options.margin.left)
.attr("height", this.options.height)
.attr("width", width - 2 * margin.left)
.attr("height", height)
.attr("pointer-events", "all")
.attr("transform",
"translate(" + this.options.margin.left + "," + this.options.margin.top + ")");
"translate(" + margin.left + "," + margin.top + ")");
var context = svg.append("g")
.attr("class", "context")
.attr("transform", "translate(" + this.options.margin.left + "," + (this.options.height + this.options.margin.top + this.options.margin.bottom + this.options.brush_height) + ")");
var curve2 = context.selectAll(".curve")
.data(this.data.curves)
.enter().append("g")
.attr("class", "curve");
.attr("transform", "translate(" + margin.left + "," + (height + margin.top + margin.bottom + brush_height) + ")");
var curvegroup = focus.append("g")
.attr('clip-path', 'url(#clip)');
var curve = curvegroup.selectAll(".curve")
.data(this.data.curves)
.data(data.curves)
.enter().append("g")
.attr("class", "curve");
var curve2 = context.selectAll(".curve")
.data(data.curves)
.enter().append("g")
.attr("class", "curve");
/* Vertical line */
var line = focus.append("line")
.attr("class", "line_over")
.attr("x1", 0)
.attr("y1", 0)
.attr("x2", 0)
.attr("y2", this.options.height);
.attr("y2", height);
/* Custom rectangle to catch mouse events */
var rect = focus.append("rect")
.attr("fill", "none")
.attr("width", width - 2 * this.options.margin.left)
.attr("height", this.options.height);
.attr("width", width - 2 * margin.left)
.attr("height", height);
var tooltip = this.container
var tooltip = container
.append("div")
.attr("class", "remove")
.attr("class", "tip");
var points = [];
var path = curve.append("path")
.attr("class", "area")
.attr("d", function(d, i) {
@@ -160,105 +141,80 @@ Graphic.prototype = {
.attr("stroke-opacity", 0.8)
.style("fill", function(d) { return d.color; });
function make_x_axis() {
return d3.svg.axis()
.scale(x)
.orient("bottom")
.ticks(6)
.tickSize(-this.options.height, 0, 0)
.tickFormat("");
}
var xrules = make_x_axis();
function make_y_axis() {
return d3.svg.axis()
.scale(y)
.orient("left")
.ticks(6)
.tickSize(-(width - 2 * this.options.margin.left), 0, 0)
.tickFormat("");
}
var xrules = make_x_axis.apply(this);
focus.append("g")
.attr("class", "grid")
.attr("transform", "translate(0," + (this.options.height) + ")")
.attr("transform", "translate(0," + height + ")")
.call(xrules);
focus.append("g")
.attr("class", "grid")
.call(make_y_axis.apply(this));
.call(make_y_axis);
focus.append("g")
.attr("class", "x axis")
.attr("transform", "translate(0," + this.options.height + ")")
.attr("transform", "translate(0," + height + ")")
.call(xAxis);
focus.append("g")
.attr("class", "y axis")
.call(yAxis);
var data = this.data.curves;
rect
.on("mouseover", function(d) {
line.style("display", "block");
tooltip.style("display", "block");
data.forEach(function(d, cid) {
var display = d3.selectAll("[data-legend='" + d.name + "']")
.style("display");
if (display == "none") {
return;
}
focus.select(".tracker-" + cid).style("display", "block");
});
})
.on("mousemove", function(d) {
var mousex = d3.mouse(this)[0],
mousey = d3.mouse(this)[1];
var date = x.invert(mousex);
var text = "";
line.attr("x1", mousex)
.attr("x2", mousex);
data.forEach(function(d, cid) {
var display = d3.selectAll("[data-legend='" + d.name + "']")
.style("display");
if (display == "none") {
return;
}
var i = bisectDate(d.data, date.getTime(), 1),
d0 = d.data[i - 1],
d1 = d.data[i],
point = date.getTime() - (d0.x * 1000) > (d1.x * 1000) - date.getTime() ? d1 : d0;
text += "<p>" + d.name + ": " + point.y.toFixed(3) + "</p>";
var tracker_x = x(point.x * 1000),
tracker_y = y(point.y);
focus.selectAll(".tracker-" + cid)
.style("fill", d.color)
.attr("cx", tracker_x)
.attr("cy", tracker_y);
});
if (mousex + tooltip[0][0].clientWidth >= width - 2 * 40) {
tooltip
.style("left", (mousex - (tooltip[0][0].clientWidth - 30)) + "px");
} else {
tooltip.style("left", (mousex + 60) + "px");
rect.on("mouseover", function(d) {
line.style("display", "block");
tooltip.style("display", "block");
data.curves.forEach(function(d, cid) {
var display = d3.selectAll("[data-legend='" + d.name + "']")
.style("display");
if (display == "none") {
return;
}
tooltip.html("<p>" + date + "</p>" + text);
})
.on("mouseout", function(d) {
tooltip.style("display", "none");
line.style("display", "none");
focus.selectAll(".tracker").style("display", "none");
focus.select(".tracker-" + cid).style("display", "block");
});
}).on("mousemove", function(d) {
var mousex = d3.mouse(this)[0],
mousey = d3.mouse(this)[1];
var date = x.invert(mousex);
var text = "";
line.attr("x1", mousex).attr("x2", mousex);
data.curves.forEach(function(d, cid) {
var display = d3.selectAll("[data-legend='" + d.name + "']")
.style("display");
if (display == "none") {
return;
}
var i = bisectDate(d.data, date.getTime(), 1),
d0 = d.data[i - 1],
d1 = d.data[i],
point = date.getTime() - (d0.x * 1000) > (d1.x * 1000) - date.getTime() ? d1 : d0;
text += "<p>" + d.name + ": " + point.y.toFixed(3) + "</p>";
var tracker_x = x(point.x * 1000),
tracker_y = y(point.y);
focus.selectAll(".tracker-" + cid)
.style("fill", d.color)
.attr("cx", tracker_x)
.attr("cy", tracker_y);
});
if (mousex + tooltip[0][0].clientWidth >= width - 2 * margin.left) {
var left = mousex - (tooltip[0][0].clientWidth - (margin.left - 20));
tooltip.style("left", left + "px");
} else {
tooltip.style("left", (mousex + margin.left + 20) + "px");
}
tooltip.html("<p>" + date + "</p>" + text);
}).on("mouseout", function(d) {
tooltip.style("display", "none");
line.style("display", "none");
focus.selectAll(".tracker").style("display", "none");
});
var legend = focus.append("g")
.attr("class", "legend")
.attr("transform", "translate(50,10)")
.style("font-size", "12px")
.style("font-size", "0.8em")
.call(d3.legend);
curve2.append("path")
.attr("class", "area2")
.attr("d", function(d) { return area2(d.data); })
@@ -270,29 +226,47 @@ Graphic.prototype = {
context.append("g")
.attr("class", "x axis")
.attr("transform", "translate(0," + this.options.preview_height + ")")
.attr("transform", "translate(0," + preview_height + ")")
.call(xAxis2);
function make_preview_x_axis() {
return d3.svg.axis()
.scale(x2)
.orient("bottom")
.ticks(6)
.tickSize(-this.options.preview_height, 0, 0)
.tickFormat("");
}
context.append("g")
.attr("class", "grid")
.attr("transform", "translate(0," + (this.options.preview_height) + ")")
.call(make_preview_x_axis.apply(this));
.attr("transform", "translate(0," + preview_height + ")")
.call(make_preview_x_axis);
context.append("g")
.attr("class", "x brush")
.call(brush)
.selectAll("rect")
.attr("y", -6)
.attr("height", this.options.preview_height + this.options.brush_height);
.attr("height", preview_height + brush_height);
function make_x_axis() {
return d3.svg.axis()
.scale(x)
.orient("bottom")
.ticks(6)
.tickSize(-height, 0, 0)
.tickFormat("");
}
function make_y_axis() {
return d3.svg.axis()
.scale(y)
.orient("left")
.ticks(6)
.tickSize(-(width - 2 * margin.left), 0, 0)
.tickFormat("");
}
function make_preview_x_axis() {
return d3.svg.axis()
.scale(x2)
.orient("bottom")
.ticks(6)
.tickSize(-preview_height, 0, 0)
.tickFormat("");
}
function brushed() {
x.domain(brush.empty() ? x2.domain() : brush.extent());
@@ -302,4 +276,69 @@ Graphic.prototype = {
focus.select(".grid").call(xrules);
}
}
};
/**
* Set or get chart's width.
*
* @this {ModoChart}
* @param {integer} value new width.
* @return {number} current width.
*/
my.width = function(value) {
if (!arguments.length) return width;
width = value;
return my;
};
/**
* Set or get chart's height.
*
* @this {ModoChart}
* @param {integer} value new height.
* @return {number} current height.
*/
my.height = function(value) {
if (!arguments.length) return height;
height = value;
return my;
};
/**
* Set or get chart's margin.
*
* @this {ModoChart}
* @param {Object} value new margin.
* @return {Object} current margin.
*/
my.margin = function(value) {
if (!arguments.length) return margin;
margin = value;
return my;
};
/**
* Compute and return chart's total height.
*
* @this {ModoChart}
* @return {integer} total height.
*/
my.totalHeight = function() {
return height + 2 * margin.top
+ 2 * margin.bottom + preview_height
+ brush_height;
};
/**
* Update the chart with new data.
*
* @this {ModoChart}
* @param {Object} data new data
*/
my.update = function(data) {
container.select("svg").remove();
$(container[0][0]).empty();
my(data);
};
return my;
}
@@ -12,7 +12,7 @@ Stats.prototype = {
initialize: function(options) {
this.options = $.extend({}, this.defaults, options);
this.options.defcallback = $.proxy(this.graphs_cb, this);
this.options.defcallback = $.proxy(this.charts_cb, this);
var navobj = new History(this.options);
this.navobj = navobj;
@@ -63,12 +63,13 @@ Stats.prototype = {
listen: function() {
$(".period_selector").click($.proxy(this.change_period, this));
$("#customsend").on("click", $.proxy(this.customgraphs, this));
$("#customsend").on("click", $.proxy(this.custom_period, this));
$(window).resize($.proxy(this.resize_charts, this));
},
register_nav_callbacks: function() {
this.navobj.register_callback("graphs",
$.proxy(this.graphs_cb, this));
$.proxy(this.charts_cb, this));
},
change_period: function(e) {
@@ -79,18 +80,38 @@ Stats.prototype = {
this.navobj.setparam("period", $link.attr("data-period")).update();
},
graphs_cb: function(data) {
if (this.graphics !== undefined) {
$.each(this.graphics, function(id, graphic) {
graphic.remove();
/**
* Update all charts on resize event.
*
* @this {Stats}
*/
resize_charts: function() {
var data = this.data;
$.each(this.charts, function(id, mychart) {
mychart.update(data.graphs[id]);
});
},
/**
* Create or update charts.
*
* @this {Stats}
* @param {Object} data
*/
charts_cb: function(data) {
this.data = data;
if (this.charts !== undefined) {
$.each(this.charts, function(id, mychart) {
mychart.update(data.graphs[id]);
});
} else {
this.charts = {};
$.each(data.graphs, $.proxy(function(id, graphdef) {
var mychart = ModoChart("#gset");
this.charts[id] = mychart;
mychart(graphdef);
}, this));
}
this.graphics = [];
$.each(data.graphs, $.proxy(function(id, graphdef) {
this.graphics.push(
new Graphic("#gset", graphdef)
);
}, this));
},
search_domain: function(value) {
@@ -102,7 +123,7 @@ Stats.prototype = {
this.navobj.delparam("searchquery").update();
},
customgraphs: function(e) {
custom_period: function(e) {
e.preventDefault();
var $fromdate = $("#id_from");
var $todate = $("#id_to");