]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Time Scale Base
authorTanner Linsley <tannerlinsley@gmail.com>
Fri, 11 Sep 2015 04:48:48 +0000 (22:48 -0600)
committerTanner Linsley <tannerlinsley@gmail.com>
Fri, 11 Sep 2015 04:48:48 +0000 (22:48 -0600)
src/scales/scale.time.js [new file with mode: 0644]

diff --git a/src/scales/scale.time.js b/src/scales/scale.time.js
new file mode 100644 (file)
index 0000000..dc36742
--- /dev/null
@@ -0,0 +1,405 @@
+(function() {
+       "use strict";
+
+       var root = this,
+               Chart = root.Chart,
+               helpers = Chart.helpers;
+
+       var defaultConfig = {
+               display: true,
+               position: "bottom",
+
+               // grid line settings
+               gridLines: {
+                       show: true,
+                       color: "rgba(0, 0, 0, 0.1)",
+                       lineWidth: 1,
+                       drawOnChartArea: true,
+                       drawTicks: true, // draw ticks extending towards the label
+               },
+
+               time: {
+                       format: false, // http://momentjs.com/docs/#/parsing/string-format/
+                       unit: false, // week, month, year, etc.
+                       aggregation: 'average',
+                       display: false, //http://momentjs.com/docs/#/parsing/string-format/
+                       unitFormats: {
+                               'millisecond': 'h:mm:ss SSS', // 11:20:01 002
+                               'second': 'h:mm:ss', // 11:20:01
+                               'minute': 'h:mm:ss a', // 11:20:01 AM
+                               'hour': 'MMM D, hA', // Sept 4, 5PM
+                               'day': 'll', // Sep 4 2015 8:30 PM
+                               'week': '[W]WW - YYYY', // Week 46
+                               'month': 'MMM YYYY', // Sept 2015
+                               'quarter': '[Q]Q - YYYY', // Q3
+                               'year': 'YYYY' // 2015
+                       }
+               },
+
+               // scale numbers
+               reverse: false,
+               override: null,
+
+               // label settings
+               labels: {
+                       show: true,
+                       mirror: false,
+                       padding: 10,
+                       template: "<%=value.toLocaleString()%>",
+                       fontSize: 12,
+                       fontStyle: "normal",
+                       fontColor: "#666",
+                       fontFamily: "Helvetica Neue"
+               }
+       };
+
+       var TimeScale = Chart.Element.extend({
+               isHorizontal: function() {
+                       return this.options.position == "top" || this.options.position == "bottom";
+               },
+               parseTime: function(label) {
+                       if (typeof this.options.time.format !== 'string' && this.options.time.format.call) {
+                               return this.options.time.format(label);
+                       } else {
+                               return moment(label, this.options.time.format);
+                       }
+               },
+               buildLabels: function(index) {
+                       // Actual labels on the grid
+                       this.labels = [];
+                       // A map of original labelIndex to time labelIndex
+                       this.timeLabelIndexMap = {};
+
+                       var definedMoments = [];
+
+                       // Format each point into a moment
+                       this.data.labels.forEach(function(label, index) {
+                               definedMoments.push(this.parseTime(label));
+                       }, this);
+
+
+                       // Find or set the unit of time
+                       if (!this.options.time.unit) {
+
+                               // Determine the smallest needed unit of the time
+                               helpers.each([
+                                       'millisecond',
+                                       'second',
+                                       'minute',
+                                       'hour',
+                                       'day',
+                                       'week',
+                                       'month',
+                                       'quarter',
+                                       'year',
+                               ], function(format) {
+                                       if (this.timeUnit) {
+                                               return;
+                                       }
+                                       var start;
+                                       helpers.each(definedMoments, function(mom) {
+                                               if (!start) {
+                                                       start = mom[format]();
+                                               }
+
+                                               if (mom[format]() !== start) {
+                                                       this.timeUnit = format;
+                                                       if (!this.displayFormat) {
+                                                               this.displayFormat = this.options.time.unitFormats[format];
+                                                       }
+                                               }
+                                       }, this);
+                               }, this);
+                       } else {
+                               this.timeUnit = this.options.time.unit;
+                       }
+
+                       if (!this.timeUnit) {
+                               this.timeUnit = 'day';
+                               this.displayFormat = this.options.time.unitFormats.day;
+                       }
+
+
+                       if (this.options.time.display) {
+                               this.displayFormat = this.options.time.display;
+                       }
+
+
+                       // Find the first and last moments
+                       this.firstMoment = moment.min.call(this, definedMoments);
+                       this.lastMoment = moment.max.call(this, definedMoments);
+
+                       // Find the length of the timeframe in the desired unit
+                       var momentRangeLength = this.lastMoment.diff(this.firstMoment, this.timeUnit);
+
+                       helpers.each(definedMoments, function(definedMoment, index) {
+                               this.timeLabelIndexMap[index] = momentRangeLength - this.lastMoment.diff(definedMoment, this.timeUnit);
+                       }, this);
+
+                       // For every unit in between the first and last moment, create a moment and add it to the labels tick
+                       var i = 0;
+                       if (this.options.labels.userCallback) {
+                               for (; i <= momentRangeLength; i++) {
+                                       this.labels.push(
+                                               this.options.labels.userCallback(this.firstMoment
+                                                       .add((!i ? 0 : 1), this.timeUnit)
+                                                       .format(this.options.time.display ? this.options.time.display : this.displayFormat)
+                                               )
+                                       );
+                               }
+                       } else {
+                               for (; i <= momentRangeLength; i++) {
+                                       this.labels.push(this.firstMoment
+                                               .add((!i ? 0 : 1), this.timeUnit)
+                                               .format(this.options.time.display ? this.options.time.display : this.displayFormat)
+                                       );
+                               }
+                       }
+
+
+               },
+               getPixelForValue: function(value, index, datasetIndex, includeOffset) {
+                       // This must be called after fit has been run so that 
+                       //      this.left, this.top, this.right, and this.bottom have been defined
+                       if (this.isHorizontal()) {
+                               var innerWidth = this.width - (this.paddingLeft + this.paddingRight);
+                               var valueWidth = innerWidth / Math.max((this.labels.length - ((this.options.gridLines.offsetGridLines) ? 0 : 1)), 1);
+                               var valueOffset = (valueWidth * index) + this.paddingLeft;
+
+                               if (this.options.gridLines.offsetGridLines && includeOffset) {
+                                       valueOffset += (valueWidth / 2);
+                               }
+
+                               return this.left + Math.round(valueOffset);
+                       } else {
+                               return this.top + (index * (this.height / this.labels.length));
+                       }
+               },
+               getPointPixelForValue: function(value, index, datasetIndex) {
+                       // This function references the timeLaabelIndexMap to know which index in the timeLabels corresponds to the index of original labels
+                       return this.getPixelForValue(value, this.timeLabelIndexMap[index], datasetIndex, true);
+               },
+
+               // Functions needed for bar charts
+               calculateBaseWidth: function() {
+                       return (this.getPixelForValue(null, 1, 0, true) - this.getPixelForValue(null, 0, 0, true)) - (2 * this.options.categorySpacing);
+               },
+               calculateBarWidth: function(barDatasetCount) {
+                       //The padding between datasets is to the right of each bar, providing that there are more than 1 dataset
+                       var baseWidth = this.calculateBaseWidth() - ((barDatasetCount - 1) * this.options.spacing);
+
+                       if (this.options.stacked) {
+                               return baseWidth;
+                       }
+                       return (baseWidth / barDatasetCount);
+               },
+               calculateBarX: function(barDatasetCount, datasetIndex, elementIndex) {
+                       var xWidth = this.calculateBaseWidth(),
+                               xAbsolute = this.getPixelForValue(null, elementIndex, datasetIndex, true) - (xWidth / 2),
+                               barWidth = this.calculateBarWidth(barDatasetCount);
+
+                       if (this.options.stacked) {
+                               return xAbsolute + barWidth / 2;
+                       }
+
+                       return xAbsolute + (barWidth * datasetIndex) + (datasetIndex * this.options.spacing) + barWidth / 2;
+               },
+
+               calculateLabelRotation: function(maxHeight, margins) {
+                       //Get the width of each grid by calculating the difference
+                       //between x offsets between 0 and 1.
+                       var labelFont = helpers.fontString(this.options.labels.fontSize, this.options.labels.fontStyle, this.options.labels.fontFamily);
+                       this.ctx.font = labelFont;
+
+                       var firstWidth = this.ctx.measureText(this.labels[0]).width;
+                       var lastWidth = this.ctx.measureText(this.labels[this.labels.length - 1]).width;
+                       var firstRotated;
+                       var lastRotated;
+
+                       this.paddingRight = lastWidth / 2 + 3;
+                       this.paddingLeft = firstWidth / 2 + 3;
+
+                       this.labelRotation = 0;
+
+                       if (this.options.display) {
+                               var originalLabelWidth = helpers.longestText(this.ctx, labelFont, this.labels);
+                               var cosRotation;
+                               var sinRotation;
+                               var firstRotatedWidth;
+
+                               this.labelWidth = originalLabelWidth;
+
+                               //Allow 3 pixels x2 padding either side for label readability
+                               // only the index matters for a dataset scale, but we want a consistent interface between scales
+
+                               var datasetWidth = Math.floor(this.getPixelForValue(0, 1) - this.getPixelForValue(0, 0)) - 6;
+
+                               //Max label rotation can be set or default to 90 - also act as a loop counter
+                               while (this.labelWidth > datasetWidth && this.labelRotation <= this.options.labels.maxRotation) {
+                                       cosRotation = Math.cos(helpers.toRadians(this.labelRotation));
+                                       sinRotation = Math.sin(helpers.toRadians(this.labelRotation));
+
+                                       firstRotated = cosRotation * firstWidth;
+                                       lastRotated = cosRotation * lastWidth;
+
+                                       // We're right aligning the text now.
+                                       if (firstRotated + this.options.labels.fontSize / 2 > this.yLabelWidth) {
+                                               this.paddingLeft = firstRotated + this.options.labels.fontSize / 2;
+                                       }
+
+                                       this.paddingRight = this.options.labels.fontSize / 2;
+
+                                       if (sinRotation * originalLabelWidth > maxHeight) {
+                                               // go back one step
+                                               this.labelRotation--;
+                                               break;
+                                       }
+
+                                       this.labelRotation++;
+                                       this.labelWidth = cosRotation * originalLabelWidth;
+
+                               }
+                       } else {
+                               this.labelWidth = 0;
+                               this.paddingRight = 0;
+                               this.paddingLeft = 0;
+                       }
+
+                       if (margins) {
+                               this.paddingLeft -= margins.left;
+                               this.paddingRight -= margins.right;
+
+                               this.paddingLeft = Math.max(this.paddingLeft, 0);
+                               this.paddingRight = Math.max(this.paddingRight, 0);
+                       }
+
+               },
+               // Fit this axis to the given size
+               // @param {number} maxWidth : the max width the axis can be
+               // @param {number} maxHeight: the max height the axis can be
+               // @return {object} minSize : the minimum size needed to draw the axis
+               fit: function(maxWidth, maxHeight, margins) {
+                       // Set the unconstrained dimension before label rotation
+                       if (this.isHorizontal()) {
+                               this.width = maxWidth;
+                       } else {
+                               this.height = maxHeight;
+                       }
+
+                       this.buildLabels();
+                       this.calculateLabelRotation(maxHeight, margins);
+
+                       var minSize = {
+                               width: 0,
+                               height: 0,
+                       };
+
+                       var labelFont = helpers.fontString(this.options.labels.fontSize, this.options.labels.fontStyle, this.options.labels.fontFamily);
+                       var longestLabelWidth = helpers.longestText(this.ctx, labelFont, this.labels);
+
+                       // Width
+                       if (this.isHorizontal()) {
+                               minSize.width = maxWidth;
+                       } else if (this.options.display) {
+                               var labelWidth = this.options.labels.show ? longestLabelWidth + 6 : 0;
+                               minSize.width = Math.min(labelWidth, maxWidth);
+                       }
+
+                       // Height
+                       if (this.isHorizontal() && this.options.display) {
+                               var labelHeight = (Math.sin(helpers.toRadians(this.labelRotation)) * longestLabelWidth) + 1.5 * this.options.labels.fontSize;
+                               minSize.height = Math.min(this.options.labels.show ? labelHeight : 0, maxHeight);
+                       } else if (this.options.display) {
+                               minSize.height = maxHeight;
+                       }
+
+                       this.width = minSize.width;
+                       this.height = minSize.height;
+                       return minSize;
+               },
+               // Actualy draw the scale on the canvas
+               // @param {rectangle} chartArea : the area of the chart to draw full grid lines on
+               draw: function(chartArea) {
+                       if (this.options.display) {
+
+                               var setContextLineSettings;
+
+                               // Make sure we draw text in the correct color
+                               this.ctx.fillStyle = this.options.labels.fontColor;
+
+                               if (this.isHorizontal()) {
+                                       setContextLineSettings = true;
+                                       var yTickStart = this.options.position == "bottom" ? this.top : this.bottom - 10;
+                                       var yTickEnd = this.options.position == "bottom" ? this.top + 10 : this.bottom;
+                                       var isRotated = this.labelRotation !== 0;
+                                       var skipRatio = false;
+
+                                       if ((this.options.labels.fontSize + 4) * this.labels.length > (this.width - (this.paddingLeft + this.paddingRight))) {
+                                               skipRatio = 1 + Math.floor(((this.options.labels.fontSize + 4) * this.labels.length) / (this.width - (this.paddingLeft + this.paddingRight)));
+                                       }
+
+                                       helpers.each(this.labels, function(label, index) {
+                                               // Blank labels
+                                               if ((skipRatio > 1 && index % skipRatio > 0) || (label === undefined || label === null)) {
+                                                       return;
+                                               }
+                                               var xLineValue = this.getPixelForValue(label, index, null, false); // xvalues for grid lines
+                                               var xLabelValue = this.getPixelForValue(label, index, null, true); // x values for labels (need to consider offsetLabel option)
+
+                                               if (this.options.gridLines.show) {
+                                                       if (index === 0) {
+                                                               // Draw the first index specially
+                                                               this.ctx.lineWidth = this.options.gridLines.zeroLineWidth;
+                                                               this.ctx.strokeStyle = this.options.gridLines.zeroLineColor;
+                                                               setContextLineSettings = true; // reset next time
+                                                       } else if (setContextLineSettings) {
+                                                               this.ctx.lineWidth = this.options.gridLines.lineWidth;
+                                                               this.ctx.strokeStyle = this.options.gridLines.color;
+                                                               setContextLineSettings = false;
+                                                       }
+
+                                                       xLineValue += helpers.aliasPixel(this.ctx.lineWidth);
+
+                                                       // Draw the label area
+                                                       this.ctx.beginPath();
+
+                                                       if (this.options.gridLines.drawTicks) {
+                                                               this.ctx.moveTo(xLineValue, yTickStart);
+                                                               this.ctx.lineTo(xLineValue, yTickEnd);
+                                                       }
+
+                                                       // Draw the chart area
+                                                       if (this.options.gridLines.drawOnChartArea) {
+                                                               this.ctx.moveTo(xLineValue, chartArea.top);
+                                                               this.ctx.lineTo(xLineValue, chartArea.bottom);
+                                                       }
+
+                                                       // Need to stroke in the loop because we are potentially changing line widths & colours
+                                                       this.ctx.stroke();
+                                               }
+
+                                               if (this.options.labels.show) {
+                                                       this.ctx.save();
+                                                       this.ctx.translate(xLabelValue, (isRotated) ? this.top + 12 : this.top + 8);
+                                                       this.ctx.rotate(helpers.toRadians(this.labelRotation) * -1);
+                                                       this.ctx.font = this.font;
+                                                       this.ctx.textAlign = (isRotated) ? "right" : "center";
+                                                       this.ctx.textBaseline = (isRotated) ? "middle" : "top";
+                                                       this.ctx.fillText(label, 0, 0);
+                                                       this.ctx.restore();
+                                               }
+                                       }, this);
+                               } else {
+                                       // Vertical
+                                       if (this.options.gridLines.show) {}
+
+                                       if (this.options.labels.show) {
+                                               // Draw the labels
+                                       }
+                               }
+                       }
+               }
+       });
+       Chart.scaleService.registerScaleType("time", TimeScale, defaultConfig);
+
+}).call(this);