src/plugins/grid.js

   1 /**
   2  * @license
   3  * Copyright 2012 Dan Vanderkam (danvdk@gmail.com)
   4  * MIT-licensed (http://opensource.org/licenses/MIT)
   5  */
   6 /*global Dygraph:false */
   7
   8 /*
   9
  10 Current bits of jankiness:
  11 - Direct layout access
  12 - Direct area access
  13
  14 */
  15
  16 "use strict";
  17
  18
  19 /**
  20  * Draws the gridlines, i.e. the gray horizontal & vertical lines running the
  21  * length of the chart.
  22  *
  23  * @constructor
  24  */
  25 var grid = function() {
  26 };
  27
  28 grid.prototype.toString = function() {
  29   return "Gridline Plugin";
  30 };
  31
  32 grid.prototype.activate = function(g) {
  33   return {
  34     willDrawChart: this.willDrawChart
  35   };
  36 };
  37
  38 grid.prototype.willDrawChart = function(e) {
  39   // Draw the new X/Y grid. Lines appear crisper when pixels are rounded to
  40   // half-integers. This prevents them from drawing in two rows/cols.
  41   var g = e.dygraph;
  42   var ctx = e.drawingContext;
  43   var layout = g.layout_;
  44   var area = e.dygraph.plotter_.area;
  45
  46   function halfUp(x)  { return Math.round(x) + 0.5; }
  47   function halfDown(y){ return Math.round(y) - 0.5; }
  48
  49   var x, y, i, ticks;
  50   if (g.getOptionForAxis('drawGrid', 'y')) {
  51     var axes = ["y", "y2"];
  52     var strokeStyles = [], lineWidths = [], drawGrid = [], stroking = [], strokePattern = [];
  53     for (var i = 0; i < axes.length; i++) {
  54       drawGrid[i] = g.getOptionForAxis('drawGrid', axes[i]);
  55       if (drawGrid[i]) {
  56         strokeStyles[i] = g.getOptionForAxis('gridLineColor', axes[i]);
  57         lineWidths[i] = g.getOptionForAxis('gridLineWidth', axes[i]);
  58         strokePattern[i] = g.getOptionForAxis('gridLinePattern', axes[i]);
  59         stroking[i] = strokePattern[i] && (strokePattern[i].length >= 2);
  60       }
  61     }
  62     ticks = layout.yticks;
  63     ctx.save();
  64     // draw grids for the different y axes
  65     for (var tick of ticks) {
  66       if (!tick.has_tick) continue;
  67       var axis = tick.axis;
  68       if (drawGrid[axis]) {
  69         ctx.save();
  70         if (stroking[axis]) {
  71           if (ctx.setLineDash) ctx.setLineDash(strokePattern[axis]);
  72         }
  73         ctx.strokeStyle = strokeStyles[axis];
  74         ctx.lineWidth = lineWidths[axis];
  75
  76         x = halfUp(area.x);
  77         y = halfDown(area.y + tick.pos * area.h);
  78         ctx.beginPath();
  79         ctx.moveTo(x, y);
  80         ctx.lineTo(x + area.w, y);
  81         ctx.stroke();
  82
  83         ctx.restore();
  84       }
  85     }
  86     ctx.restore();
  87   }
  88
  89   // draw grid for x axis
  90   if (g.getOptionForAxis('drawGrid', 'x')) {
  91     ticks = layout.xticks;
  92     ctx.save();
  93     var strokePattern = g.getOptionForAxis('gridLinePattern', 'x');
  94     var stroking = strokePattern && (strokePattern.length >= 2);
  95     if (stroking) {
  96       if (ctx.setLineDash) ctx.setLineDash(strokePattern);
  97     }
  98     ctx.strokeStyle = g.getOptionForAxis('gridLineColor', 'x');
  99     ctx.lineWidth = g.getOptionForAxis('gridLineWidth', 'x');
 100     for (var tick of ticks) {
 101       if (!tick.has_tick) continue;
 102       x = halfUp(area.x + tick.pos * area.w);
 103       y = halfDown(area.y + area.h);
 104       ctx.beginPath();
 105       ctx.moveTo(x, y);
 106       ctx.lineTo(x, area.y);
 107       ctx.closePath();
 108       ctx.stroke();
 109     }
 110     if (stroking) {
 111       if (ctx.setLineDash) ctx.setLineDash([]);
 112     }
 113     ctx.restore();
 114   }
 115 };
 116
 117 grid.prototype.destroy = function() {
 118 };
 119
 120 export default grid;