From 2fccd3dce147fec801214cd4789fe263ce95c5b8 Mon Sep 17 00:00:00 2001
From: Dan Vanderkam <dan@dygraphs.com>
Date: Thu, 10 Mar 2011 00:56:00 -0500
Subject: [PATCH] add "legend" option and an example of its usage.

---
 dygraph.js       | 30 +++++++++++++++++++++++++++++-
 tests/noise.html | 10 ++++++++--
 2 files changed, 37 insertions(+), 3 deletions(-)

diff --git a/dygraph.js b/dygraph.js
index 4f9216d..9b961e6 100644
--- a/dygraph.js
+++ b/dygraph.js
@@ -187,6 +187,9 @@ Dygraph.DEFAULT_ATTRS = {
   stackedGraph: false,
   hideOverlayOnMouseOut: true,
 
+  // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
+  legend: 'onmouseover',  // the only relevant value at the moment is 'always'.
+
   stepPlot: false,
   avoidMinZero: false,
 
@@ -1553,11 +1556,30 @@ Dygraph.prototype.idxToRow_ = function(idx) {
   return -1;
 };
 
+// TODO(danvk): rename this function to something like 'isNonZeroNan'.
 Dygraph.isOK = function(x) {
   return x && !isNaN(x);
 };
 
 Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
+  // If no points are selected, we display a default legend. Traditionally,
+  // this has been blank. But a better default would be a conventional legend,
+  // which provides essential information for a non-interactive chart.
+  if (typeof(x) === 'undefined') {
+    if (this.attr_('legend') != 'always') return '';
+
+    var sepLines = this.attr_('labelsSeparateLines');
+    var labels = this.attr_('labels');
+    var html = '';
+    for (var i = 1; i < labels.length; i++) {
+      var c = new RGBColor(this.plotter_.colors[labels[i]]);
+      if (i > 1) html += (sepLines ? '<br/>' : ' ');
+      html += "<b><font color='" + c.toHex() + "'>&mdash;" + labels[i] +
+        "</font></b>";
+    }
+    return html;
+  }
+
   var displayDigits = this.numXDigits_ + this.numExtraDigits_;
   var html = this.attr_('xValueFormatter')(x, displayDigits) + ":";
 
@@ -1572,6 +1594,7 @@ Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
 
     var c = new RGBColor(this.plotter_.colors[pt.name]);
     var yval = fmtFunc(pt.yval, displayDigits);
+    // TODO(danvk): use a template string here and make it an attribute.
     html += " <b><font color='" + c.toHex() + "'>"
       + pt.name + "</font></b>:"
       + yval;
@@ -1689,7 +1712,7 @@ Dygraph.prototype.clearSelection = function() {
   // Get rid of the overlay data
   var ctx = this.canvas_.getContext("2d");
   ctx.clearRect(0, 0, this.width_, this.height_);
-  this.attr_("labelsDiv").innerHTML = "";
+  this.attr_('labelsDiv').innerHTML = this.generateLegendHTML_();
   this.selPoints_ = [];
   this.lastx_ = -1;
 }
@@ -2474,6 +2497,11 @@ Dygraph.prototype.drawGraph_ = function() {
   this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
                                           this.canvas_.height);
 
+  if (is_initial_draw) {
+    // Generate a static legend before any particular point is selected.
+    this.attr_('labelsDiv').innerHTML = this.generateLegendHTML_();
+  }
+
   if (this.attr_("drawCallback") !== null) {
     this.attr_("drawCallback")(this, is_initial_draw);
   }
diff --git a/tests/noise.html b/tests/noise.html
index bdec05f..7a666bf 100644
--- a/tests/noise.html
+++ b/tests/noise.html
@@ -21,14 +21,20 @@
             document.getElementById("div_g"),
             NoisyData, {
               rollPeriod: 7,
-              errorBars: true
+              errorBars: true,
+              legend: 'always'
             }
           );
       g30 = new Dygraph(
             document.getElementById("div_g30"),
             NoisyData().replace(/,/g, "\t"), {
               rollPeriod: 14,
-              errorBars: true
+              errorBars: true,
+              legend: 'always',
+              labelsDivStyles: {
+                'text-align': 'right',
+              },
+              labelsDivWidth: 170
             }
           );
     </script>
-- 
2.7.4