/*global define */ define(['jquery', 'underscore', 'backbone', 'd3'], function($, _, Backbone, d3) { 'use strict'; // Draw a line chart var LineChartView = Backbone.View.extend({ initialize: function (options) { if(!d3){ console.log('SVG is not supported'); return null; } /* OPTIONS: * data: An array of data to use to draw the line. Each point on the line needs a date and count. * The points will be drawn in order, so sort the array in ascending time order first * Format example: * [{date: "13-01-08", count: 500}, {date: "20-03-12", count: 30}] * formatFromSolrFacets = format the raw Solr data sent before drawing the chart - Solr format would be an array like: ["2001-10-24T23:00:00Z", 12], etc. * cumulative: the data will be formatted as a cumulative chart * id: The id to use for the svg element * frequency = add a point for every X points in our data set (i.e. a point for every 12 months) * labelDate = Instructions for how to display the date * m - month only * y - year only * d - date only * m-y - month and year (e.g. 9/2013) * M y - month name and year (e.g. September 2013) * m-d-y - month, date, and year * labelValue = a string to prepend to the value displayed in the label for line points * labelWidth = width of the label box, in pixels * radius = radius of the point circle * className = class to give the line path and point circle elements * width = width of SVG element * height = height of SVG element * xTicks = d3.time function for the x-axis tick marks * xTickFormat = d3.time.format() argument for formatting x-axis tick marks */ if(!options.data) return; this.data = options.data; this.id = options.id || ""; this.className = options.className || ""; this.frequency = options.frequency || 1; //Use 0 to not add any points if(!options.data) this.frequency = 0; //If no data is provided, do not draw any points (otherwise, one point at 0,0 will be drawn) this.yLabel = options.yLabel || ""; this.labelValue = options.labelValue || ""; this.labelWidth = options.labelWidth || (this.labelValue.length * 7) + (this.yLabel.length * 7) + 60; this.radius = options.radius || 6; this.width = options.width || 650; this.height = options.height || 300; this.formatFromSolrFacets = options.formatFromSolrFacets || false; this.cumulative = options.cumulative || false; if(options.data && this.formatFromSolrFacets) this.data = this.formatData(options.data); //What will our x-axis tick format be? //Find the time span - 2628000000 ms is one month var timeSpan = new Date(this.data[this.data.length-1].date) - new Date(this.data[0].date); var months = 2628000000*13; function getTickFormat(){ if(timeSpan <= months) return d3.time.format("%b"); else return d3.time.format("%Y"); } function getTicks(){ if(timeSpan <= months) return d3.time.months; else return d3.time.years; } function getLabelDate(){ if(timeSpan <= months) return "M y"; else return "y"; } this.xTicks = options.xTicks || getTicks(); this.xTickFormat = options.xTickFormat || getTickFormat(); this.labelDate = options.labelDate || getLabelDate(); //The format for the date - can be modified for each chart. This is the format for ISO dates returned from Solr this.parseDate = d3.time.format("%Y-%m-%d").parse; }, // http://stackoverflow.com/questions/9651167/svg-not-rendering-properly-as-a-backbone-view // Give our el a svg namespace because Backbone gives a different one automatically nameSpace: "http://www.w3.org/2000/svg", _ensureElement: function() { if (!this.el) { var attrs = _.extend({}, _.result(this, 'attributes')); if (this.id) attrs.id = _.result(this, 'id'); if (this.className) attrs['class'] = _.result(this, 'className'); var $el = $(window.document.createElementNS(_.result(this, 'nameSpace'), _.result(this, 'tagName'))).attr(attrs); this.setElement($el, false); } else { this.setElement(_.result(this, 'el'), false); } }, tagName: "svg", /* * This function draws a line time series chart */ render: function () { var viewRef = this; /* * ======================================================================== * Set up the basic settings of our line chart (margins, scales, and axis) * ======================================================================== */ if(!this.data) return this; var margin = {top: 20, right: 50, bottom: 50, left: 80}; this.margin = margin; this.width = this.width - margin.left - margin.right; this.height = this.height - margin.top - margin.bottom; var min = d3.min(this.data, function(d) { return d.count; }), max = d3.max(this.data, function(d) { return d.count; }), difference = max - min; //Format the data this.data.forEach(function(d) { d.date = viewRef.parseDate(d.date); d.count = +d.count; }); //Set the y scale /*if((difference > 30000) || ((min < 10) && (difference > 10000))){ this.y = d3.scale.log() .range([this.height, 0]) .domain([1, max]); var log = true; this.className += " log-scale"; } else{*/ this.y = d3.scale.linear() .range([this.height, 0]) .domain([0, max]); var log = false; //} //Set the x scale this.x = d3.time.scale() .range([0, this.width]) .domain(d3.extent(this.data, function(d) { return d.date; })); //Set up the x axis var xAxis = d3.svg.axis() .scale(this.x) .orient("bottom") .ticks(this.xTicks) .tickFormat(this.xTickFormat); //Set up the y axis var yAxis = d3.svg.axis() .scale(this.y) .orient("left") .innerTickSize(["-" + this.width]); if(log) yAxis.ticks(0, ".1s"); var svg = d3.select(this.el) .attr("class", "line-chart") .attr("width", this.width + margin.left + margin.right) .attr("height", this.height + margin.top + margin.bottom) .append("g") .attr("transform", "translate(" + margin.left + "," + margin.top + ")"); /* * ======================================================================== * Append the axis * ======================================================================== */ svg.append("g") .attr("class", "x axis") .attr("transform", "translate(0," + this.height + ")") .call(xAxis); svg.append("g") .attr("class", "y axis") .call(yAxis); svg.selectAll(".x.axis .tick text") .style("text-anchor", 'end') .attr("dx", "-.8em") .attr("dy", ".15em") .attr("transform", "rotate(-65)"); /* * ======================================================================== * Draw the y-axis title * ======================================================================== */ d3.select(this.el).append("text") .attr("y", 6) .attr("dy", ".71em") .style("text-anchor", "middle") .text(this.yLabel) .attr("class", "title") .attr("transform", "translate(-5, " + (this.height/2) + ") rotate(-90)"); /* * ======================================================================== * Draw the line path * ======================================================================== */ viewRef = this; var line = d3.svg.line() .x(function(d) { return viewRef.x(d.date); }) .y(function(d) { return viewRef.y(d.count); }); svg.append("path") .datum(this.data) .attr("class", "line " + this.className) .attr("d", line); /* save a reference to certain objects so we can add new lines later */ this.svg = svg; this.line = line; /* * ======================================================================== * Add points to the line * ======================================================================== */ this.addPoints(); return this; }, /* * This function will add another line to the chart, using the same scales */ addLine: function(data){ var viewRef = this; if(this.formatFromSolrFacets){ data = this.formatData(data); } data.forEach(function(d) { d.date = viewRef.parseDate(d.date); d.count = +d.count; }); var line = d3.svg.line() .x(function(d) { return viewRef.x(d.date); }) .y(function(d) { return viewRef.y(d.count); }); //.interpolate("linear"); this.svg.append("path") .datum(data) .attr("class", "line " + this.className) .attr("d", line); this.data = data; this.addPoints(); }, /* * This function will add points to the current line stored in this view (this.line) */ addPoints: function(){ var viewRef = this; //Should we add points? if(this.frequency > 0){ /* * ======================================================================== * Format our data for the points * ======================================================================== */ //Pare down the data to every X for the points var pointData = []; for(var i=0; i (viewRef.height - labelHeight)) yPos = yPos - labelHeight; return yPos; }) .attr("width", labelWidth) .attr("height", labelHeight) .attr("rx", 5) //For rounded corners .attr("ry", 5) //For rounded corners .attr("class", "bg line-chart-label " + this.className) .attr("text-anchor", "end") .attr("data-id", function(d, i){ return viewRef.x(d.date) + viewRef.y(d.count); }); labels.append("text") .text(function(d, i){ var date = ""; var monthNames = [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ]; //Format the date according to the options passed to this line chart switch(viewRef.labelDate){ case "y": date = new Date(d.date).getFullYear(); break; case "m": date = new Date(d.date).getMonth(); break; case "d": date = new Date(d.date).getDate(); break; case "m-y": date = new Date(d.date); date = date.getMonth() + "/" + date.getFullYear(); break; case "M y": date = new Date(d.date); date = monthNames[date.getMonth()] + " " + date.getFullYear(); break; case "m-d-y": date = new Date(d.date); date = date.getMonth() + "/" + date.getDate() + "/" + date.getFullYear(); break; default: date = new Date(d.date); date = monthNames[date.getMonth()] + " " + date.getFullYear(); break; } return date; }) .attr("x", function(d, i){ var xPos = viewRef.x(d.date) - (labelWidth/2); //Don't let our label bleed off the edge if(xPos < 0) xPos = xPos + labelWidth; return xPos + labelXPadding; }) .attr("y", function(d, i){ var yPos = viewRef.y(d.count) + viewRef.radius; //Don't let our label bleed off the edge if(yPos < 0) yPos = yPos + labelHeight; else if(yPos > (viewRef.height - labelHeight)) yPos = yPos - labelHeight; return yPos + labelYPadding; }) .attr("class", "text line-chart-label " + this.className) .attr("text-anchor", "start") .attr("data-id", function(d, i){ return viewRef.x(d.date) + viewRef.y(d.count); }); labels.append("text") .text(function(d, i){ return viewRef.labelValue + MetacatUI.appView.commaSeparateNumber(d.count) + " " + viewRef.yLabel; }) .attr("x", function(d, i){ var xPos = viewRef.x(d.date) - (labelWidth/2); //Don't let our label bleed off the edge if(xPos < 0) xPos = xPos + labelWidth; return xPos + labelXPadding; }) .attr("y", function(d, i){ var yPos = viewRef.y(d.count) + viewRef.radius; //Don't let our label bleed off the edge if(yPos < 0) yPos = yPos + labelHeight; else if(yPos > (viewRef.height - labelHeight)) yPos = yPos - labelHeight; return yPos + labelYPadding + 20; }) .attr("class", "text line-chart-label " + this.className) .attr("text-anchor", "start") .attr("data-id", function(d, i){ return viewRef.x(d.date) + viewRef.y(d.count); }); } /* * Add an event listener to our points so we can display the labels */ var viewRef = this; this.$('.point').hover( function(e){ //Fade in our labels var activePoint = $(e.target); viewRef.$("[data-id='" + activePoint.attr("data-id") + "'].line-chart-label").fadeIn(200); }, //Fade out the labels function(e){ var activePoint = $(e.target); viewRef.$("[data-id='" + activePoint.attr("data-id") + "'].line-chart-label").fadeOut(100); } ); }, formatData: function(counts){ //Format the data for a cumulative time series chart //We will take only the first 10 characters of the date //To make it a cumulative chart, we will keep adding to the count var newData = []; var totalCount = 0; for(var i=0; i < counts.length; i+=2){ if(this.cumulative) totalCount += counts[i+1]; else totalCount = counts[i+1]; newData.push({ date: counts[i].substr(0, 10), count: totalCount }); } return newData; } }); return LineChartView; });