working w/o scientific notation
[dygraphs.git] / dygraph.js
index 88ad4b8..377e830 100644 (file)
@@ -72,59 +72,6 @@ Dygraph.toString = function() {
   return this.__repr__();
 };
 
-/**
- * Formatting to use for an integer number.
- *
- * @param {Number} x The number to format
- * @param {Number} unused_precision The precision to use, ignored.
- * @return {String} A string formatted like %g in printf.  The max generated
- *                  string length should be precision + 6 (e.g 1.123e+300).
- */
-Dygraph.intFormat = function(x, unused_precision) {
-  return x.toString();
-}
-
-/**
- * Number formatting function which mimicks the behavior of %g in printf, i.e.
- * either exponential or fixed format (without trailing 0s) is used depending on
- * the length of the generated string.  The advantage of this format is that
- * there is a predictable upper bound on the resulting string length,
- * significant figures are not dropped, and normal numbers are not displayed in
- * exponential notation.
- *
- * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
- * It creates strings which are too long for absolute values between 10^-4 and
- * 10^-6.  See tests/number-format.html for output examples.
- *
- * @param {Number} x The number to format
- * @param {Number} opt_precision The precision to use, default 2.
- * @return {String} A string formatted like %g in printf.  The max generated
- *                  string length should be precision + 6 (e.g 1.123e+300).
- */
-Dygraph.floatFormat = function(x, opt_precision) {
-  // Avoid invalid precision values; [1, 21] is the valid range.
-  var p = Math.min(Math.max(1, opt_precision || 2), 21);
-
-  // This is deceptively simple.  The actual algorithm comes from:
-  //
-  // Max allowed length = p + 4
-  // where 4 comes from 'e+n' and '.'.
-  //
-  // Length of fixed format = 2 + y + p
-  // where 2 comes from '0.' and y = # of leading zeroes.
-  //
-  // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
-  // 1.0e-3.
-  //
-  // Since the behavior of toPrecision() is identical for larger numbers, we
-  // don't have to worry about the other bound.
-  //
-  // Finally, the argument for toExponential() is the number of trailing digits,
-  // so we take off 1 for the value before the '.'.
-  return (Math.abs(x) < 1.0e-3 && x != 0.0) ?
-      x.toExponential(p - 1) : x.toPrecision(p);
-};
-
 // Various default values
 Dygraph.DEFAULT_ROLL_PERIOD = 1;
 Dygraph.DEFAULT_WIDTH = 480;
@@ -153,11 +100,9 @@ Dygraph.DEFAULT_ATTRS = {
   labelsKMG2: false,
   showLabelsOnHighlight: true,
 
-  yValueFormatter: function(x, opt_precision) {
-    var s = Dygraph.floatFormat(x, opt_precision);
-    var s2 = Dygraph.intFormat(x);
-    return s.length < s2.length ? s : s2;
-  },
+  yValueFormatter: function(a,b) { return Dygraph.numberFormatter(a,b); },
+  digitsAfterDecimal: 2,
+  maxNumberWidth: 6,
 
   strokeWidth: 1.0,
 
@@ -263,19 +208,9 @@ Dygraph.prototype.__init__ = function(div, file, attrs) {
   this.is_initial_draw_ = true;
   this.annotations_ = [];
 
-  // Number of digits to use when labeling the x (if numeric) and y axis
-  // ticks.
-  this.numXDigits_ = 2;
-  this.numYDigits_ = 2;
-
-  // When labeling x (if numeric) or y values in the legend, there are
-  // numDigits + numExtraDigits of precision used.  For axes labels with N
-  // digits of precision, the data should be displayed with at least N+1 digits
-  // of precision. The reason for this is to divide each interval between
-  // successive ticks into tenths (for 1) or hundredths (for 2), etc.  For
-  // example, if the labels are [0, 1, 2], we want data to be displayed as
-  // 0.1, 1.3, etc.
-  this.numExtraDigits_ = 1;
+  // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
+  this.zoomed_x_ = false;
+  this.zoomed_y_ = false;
 
   // Clear the div. This ensure that, if multiple dygraphs are passed the same
   // div, then only one will be drawn.
@@ -339,6 +274,22 @@ Dygraph.prototype.__init__ = function(div, file, attrs) {
   this.start_();
 };
 
+/**
+ * Returns the zoomed status of the chart for one or both axes.
+ *
+ * Axis is an optional parameter. Can be set to 'x' or 'y'.
+ *
+ * The zoomed status for an axis is set whenever a user zooms using the mouse
+ * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
+ * option is also specified).
+ */
+Dygraph.prototype.isZoomed = function(axis) {
+  if (axis == null) return this.zoomed_x_ || this.zoomed_y_;
+  if (axis == 'x') return this.zoomed_x_;
+  if (axis == 'y') return this.zoomed_y_;
+  throw "axis parameter to Dygraph.isZoomed must be missing, 'x' or 'y'.";
+};
+
 Dygraph.prototype.toString = function() {
   var maindiv = this.maindiv_;
   var id = (maindiv && maindiv.id) ? maindiv.id : maindiv
@@ -1503,6 +1454,7 @@ Dygraph.prototype.doZoomX_ = function(lowX, highX) {
  */
 Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
   this.dateWindow_ = [minDate, maxDate];
+  this.zoomed_x_ = true;
   this.drawGraph_();
   if (this.attr_("zoomCallback")) {
     this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
@@ -1530,9 +1482,11 @@ Dygraph.prototype.doZoomY_ = function(lowY, highY) {
     valueRanges.push([low, hi]);
   }
 
+  this.zoomed_y_ = true;
   this.drawGraph_();
   if (this.attr_("zoomCallback")) {
     var xRange = this.xAxisRange();
+    var yRange = this.yAxisRange();
     this.attr_("zoomCallback")(xRange[0], xRange[1], this.yAxisRanges());
   }
 };
@@ -1560,6 +1514,8 @@ Dygraph.prototype.doUnzoom_ = function() {
   if (dirty) {
     // Putting the drawing operation before the callback because it resets
     // yAxisRange.
+    this.zoomed_x_ = false;
+    this.zoomed_y_ = false;
     this.drawGraph_();
     if (this.attr_("zoomCallback")) {
       var minDate = this.rawData_[0][0];
@@ -1682,8 +1638,7 @@ Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
     return html;
   }
 
-  var displayDigits = this.numXDigits_ + this.numExtraDigits_;
-  var html = this.attr_('xValueFormatter')(x, displayDigits) + ":";
+  var html = this.attr_('xValueFormatter')(x) + ":";
 
   var fmtFunc = this.attr_('yValueFormatter');
   var showZeros = this.attr_("labelsShowZeroValues");
@@ -1695,7 +1650,7 @@ Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
     if (sepLines) html += "<br/>";
 
     var c = new RGBColor(this.plotter_.colors[pt.name]);
-    var yval = fmtFunc(pt.yval, displayDigits);
+    var yval = fmtFunc(pt.yval, this);
     // TODO(danvk): use a template string here and make it an attribute.
     html += " <b><font color='" + c.toHex() + "'>"
       + pt.name + "</font></b>:"
@@ -1835,11 +1790,29 @@ Dygraph.prototype.getSelection = function() {
     }
   }
   return -1;
-}
+};
 
 Dygraph.zeropad = function(x) {
   if (x < 10) return "0" + x; else return "" + x;
-}
+};
+
+/**
+ * Return a string version of a number. This respects the digitsAfterDecimal
+ * and maxNumberWidth options.
+ * @param {Number} x The number to be formatted
+ * @param {Dygraph} g The dygraph object
+ */
+Dygraph.numberFormatter = function(x, g) {
+  var digits = g.attr_('digitsAfterDecimal');
+  var maxNumberWidth = g.attr_('maxNumberWidth');
+
+  if (Math.abs(x) >= Math.pow(10, maxNumberWidth) ||
+      Math.abs(x) < Math.pow(10, -digits)) {
+    // switch to scientific notation.
+  } else {
+    return '' + Dygraph.round_(x, digits);
+  }
+};
 
 /**
  * Return a string version of the hours, minutes and seconds portion of a date.
@@ -1857,7 +1830,7 @@ Dygraph.hmsString_ = function(date) {
   } else {
     return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
   }
-}
+};
 
 /**
  * Convert a JS date to a string appropriate to display on an axis that
@@ -1880,7 +1853,7 @@ Dygraph.dateAxisFormatter = function(date, granularity) {
       return Dygraph.hmsString_(date.getTime());
     }
   }
-}
+};
 
 /**
  * Convert a JS date (millis since epoch) to YYYY/MM/DD
@@ -1907,6 +1880,18 @@ Dygraph.dateString_ = function(date) {
 };
 
 /**
+ * Round a number to the specified number of digits past the decimal point.
+ * @param {Number} num The number to round
+ * @param {Number} places The number of decimals to which to round
+ * @return {Number} The rounded number
+ * @private
+ */
+Dygraph.round_ = function(num, places) {
+  var shift = Math.pow(10, places);
+  return Math.round(num * shift)/shift;
+};
+
+/**
  * Fires when there's data available to be graphed.
  * @param {String} data Raw CSV data to be plotted
  * @private
@@ -1933,20 +1918,7 @@ Dygraph.prototype.addXTicks_ = function() {
     range = [this.rawData_[0][0], this.rawData_[this.rawData_.length - 1][0]];
   }
 
-  var formatter = this.attr_('xTicker');
-  var ret = formatter(range[0], range[1], this);
-  var xTicks = [];
-
-  // Note: numericTicks() returns a {ticks: [...], numDigits: yy} dictionary,
-  // whereas dateTicker and user-defined tickers typically just return a ticks
-  // array.
-  if (ret.ticks !== undefined) {
-    xTicks = ret.ticks;
-    this.numXDigits_ = ret.numDigits;
-  } else {
-    xTicks = ret;
-  }
-
+  var xTicks = this.attr_('xTicker')(range[0], range[1], this);
   this.layout_.updateOptions({xTicks: xTicks});
 };
 
@@ -2194,43 +2166,6 @@ Dygraph.binarySearch = function(val, arry, abs, low, high) {
 };
 
 /**
- * Determine the number of significant figures in a Number up to the specified
- * precision.  Note that there is no way to determine if a trailing '0' is
- * significant or not, so by convention we return 1 for all of the following
- * inputs: 1, 1.0, 1.00, 1.000 etc.
- * @param {Number} x The input value.
- * @param {Number} opt_maxPrecision Optional maximum precision to consider.
- *                                  Default and maximum allowed value is 13.
- * @return {Number} The number of significant figures which is >= 1.
- */
-Dygraph.significantFigures = function(x, opt_maxPrecision) {
-  var precision = Math.max(opt_maxPrecision || 13, 13);
-
-  // Convert the number to its exponential notation form and work backwards,
-  // ignoring the 'e+xx' bit.  This may seem like a hack, but doing a loop and
-  // dividing by 10 leads to roundoff errors.  By using toExponential(), we let
-  // the JavaScript interpreter handle the low level bits of the Number for us.
-  var s = x.toExponential(precision);
-  var ePos = s.lastIndexOf('e');  // -1 case handled by return below.
-
-  for (var i = ePos - 1; i >= 0; i--) {
-    if (s[i] == '.') {
-      // Got to the decimal place.  We'll call this 1 digit of precision because
-      // we can't know for sure how many trailing 0s are significant.
-      return 1;
-    } else if (s[i] != '0') {
-      // Found the first non-zero digit.  Return the number of characters
-      // except for the '.'.
-      return i;  // This is i - 1 + 1 (-1 is for '.', +1 is for 0 based index).
-    }
-  }
-
-  // Occurs if toExponential() doesn't return a string containing 'e', which
-  // should never happen.
-  return 1;
-};
-
-/**
  * Add ticks when the x axis has numbers on it (instead of dates)
  * TODO(konigsberg): Update comment.
  *
@@ -2354,27 +2289,18 @@ Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) {
   var formatter = attr('yAxisLabelFormatter') ?
       attr('yAxisLabelFormatter') : attr('yValueFormatter');
 
-  // Determine the number of decimal places needed for the labels below by
-  // taking the maximum number of significant figures for any label.  We must
-  // take the max because we can't tell if trailing 0s are significant.
-  var numDigits = 0;
-  for (var i = 0; i < ticks.length; i++) {
-    numDigits = Math.max(Dygraph.significantFigures(ticks[i].v), numDigits);
-  }
-
   // Add labels to the ticks.
   for (var i = 0; i < ticks.length; i++) {
     if (ticks[i].label !== undefined) continue;  // Use current label.
     var tickV = ticks[i].v;
     var absTickV = Math.abs(tickV);
-    var label = (formatter !== undefined) ?
-        formatter(tickV, numDigits) : tickV.toPrecision(numDigits);
+    var label = formatter(tickV, self);
     if (k_labels.length > 0) {
       // Round up to an appropriate unit.
       var n = k*k*k*k;
       for (var j = 3; j >= 0; j--, n /= k) {
         if (absTickV >= n) {
-          label = formatter(tickV / n, numDigits) + k_labels[j];
+          label = Dygraph.round_(tickV / n, 1) + k_labels[j];
           break;
         }
       }
@@ -2382,7 +2308,7 @@ Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) {
     ticks[i].label = label;
   }
 
-  return {ticks: ticks, numDigits: numDigits};
+  return ticks;
 };
 
 // Computes the range of the data series (including confidence intervals).
@@ -2588,11 +2514,13 @@ Dygraph.prototype.drawGraph_ = function() {
   this.layout_.updateOptions( { yAxes: this.axes_,
                                 seriesToAxisMap: this.seriesToAxisMap_
                               } );
-
   this.addXTicks_();
 
+  // Save the X axis zoomed status as the updateOptions call will tend to set it errorneously
+  var tmp_zoomed_x = this.zoomed_x_;
   // Tell PlotKit to use this new data and render itself
   this.layout_.updateOptions({dateWindow: this.dateWindow_});
+  this.zoomed_x_ = tmp_zoomed_x;
   this.layout_.evaluateWithError();
   this.plotter_.clear();
   this.plotter_.render();
@@ -2620,6 +2548,15 @@ Dygraph.prototype.drawGraph_ = function() {
  *   indices are into the axes_ array.
  */
 Dygraph.prototype.computeYAxes_ = function() {
+  var valueWindows;
+  if (this.axes_ != undefined) {
+    // Preserve valueWindow settings.
+    valueWindows = [];
+    for (var index = 0; index < this.axes_.length; index++) {
+      valueWindows.push(this.axes_[index].valueWindow);
+    }
+  }
+
   this.axes_ = [{ yAxisId : 0, g : this }];  // always have at least one y-axis.
   this.seriesToAxisMap_ = {};
 
@@ -2696,6 +2633,13 @@ Dygraph.prototype.computeYAxes_ = function() {
     if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s];
   }
   this.seriesToAxisMap_ = seriesToAxisFiltered;
+
+  if (valueWindows != undefined) {
+    // Restore valueWindow settings.
+    for (var index = 0; index < valueWindows.length; index++) {
+      this.axes_[index].valueWindow = valueWindows[index];
+    }
+  }
 };
 
 /**
@@ -2727,35 +2671,36 @@ Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
     seriesForAxis[idx].push(series);
   }
 
-  // If no series are defined or visible then fill in some reasonable defaults.
-  if (seriesForAxis.length == 0) {
-    var axis = this.axes_[0];
-    axis.computedValueRange = [0, 1];
-    var ret =
-      Dygraph.numericTicks(axis.computedValueRange[0],
-                           axis.computedValueRange[1],
-                           this,
-                           axis);
-    axis.ticks = ret.ticks;
-    this.numYDigits_ = ret.numDigits;
-    return;
-  }
-
   // Compute extreme values, a span and tick marks for each axis.
   for (var i = 0; i < this.axes_.length; i++) {
     var axis = this.axes_[i];
  
-    {
+    if (!seriesForAxis[i]) {
+      // If no series are defined or visible then use a reasonable default
+      axis.extremeRange = [0, 1];
+    } else {
       // Calculate the extremes of extremes.
       var series = seriesForAxis[i];
       var minY = Infinity;  // extremes[series[0]][0];
       var maxY = -Infinity;  // extremes[series[0]][1];
+      var extremeMinY, extremeMaxY;
       for (var j = 0; j < series.length; j++) {
-        minY = Math.min(extremes[series[j]][0], minY);
-        maxY = Math.max(extremes[series[j]][1], maxY);
+        // Only use valid extremes to stop null data series' from corrupting the scale.
+        extremeMinY = extremes[series[j]][0];
+        if (extremeMinY != null) {
+          minY = Math.min(extremeMinY, minY);
+        }
+        extremeMaxY = extremes[series[j]][1];
+        if (extremeMaxY != null) {
+          maxY = Math.max(extremeMaxY, maxY);
+        }
       }
       if (axis.includeZero && minY > 0) minY = 0;
 
+      // Ensure we have a valid scale, otherwise defualt to zero for safety.
+      if (minY == Infinity) minY = 0;
+      if (maxY == -Infinity) maxY = 0;
+
       // Add some padding and round up to an integer to be human-friendly.
       var span = maxY - minY;
       // special case: if we have no sense of scale, use +/-10% of the sole value.
@@ -2799,13 +2744,11 @@ Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
     // primary axis. However, if an axis is specifically marked as having
     // independent ticks, then that is permissible as well.
     if (i == 0 || axis.independentTicks) {
-      var ret =
+      axis.ticks =
         Dygraph.numericTicks(axis.computedValueRange[0],
                              axis.computedValueRange[1],
                              this,
                              axis);
-      axis.ticks = ret.ticks;
-      this.numYDigits_ = ret.numDigits;
     } else {
       var p_axis = this.axes_[0];
       var p_ticks = p_axis.ticks;
@@ -2818,12 +2761,10 @@ Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
         tick_values.push(y_val);
       }
 
-      var ret =
+      axis.ticks =
         Dygraph.numericTicks(axis.computedValueRange[0],
                              axis.computedValueRange[1],
                              this, axis, tick_values);
-      axis.ticks = ret.ticks;
-      this.numYDigits_ = ret.numDigits;
     }
   }
 };
@@ -3021,7 +2962,7 @@ Dygraph.prototype.detectTypeFromString_ = function(str) {
     this.attrs_.xTicker = Dygraph.dateTicker;
     this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
   } else {
-    this.attrs_.xValueFormatter = this.attrs_.yValueFormatter;
+    this.attrs_.xValueFormatter = function(x) { return x; };
     this.attrs_.xValueParser = function(x) { return parseFloat(x); };
     this.attrs_.xTicker = Dygraph.numericTicks;
     this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
@@ -3244,7 +3185,7 @@ Dygraph.prototype.parseArray_ = function(data) {
     return parsedData;
   } else {
     // Some intelligent defaults for a numeric x-axis.
-    this.attrs_.xValueFormatter = this.attrs_.yValueFormatter;
+    this.attrs_.xValueFormatter = function(x) { return x; };
     this.attrs_.xTicker = Dygraph.numericTicks;
     return data;
   }
@@ -3270,7 +3211,7 @@ Dygraph.prototype.parseDataTable_ = function(data) {
     this.attrs_.xTicker = Dygraph.dateTicker;
     this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
   } else if (indepType == 'number') {
-    this.attrs_.xValueFormatter = this.attrs_.yValueFormatter;
+    this.attrs_.xValueFormatter = function(x) { return x; };
     this.attrs_.xValueParser = function(x) { return parseFloat(x); };
     this.attrs_.xTicker = Dygraph.numericTicks;
     this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
@@ -3477,6 +3418,7 @@ Dygraph.prototype.start_ = function() {
  * <li>file: changes the source data for the graph</li>
  * <li>errorBars: changes whether the data contains stddev</li>
  * </ul>
+ *
  * @param {Object} attrs The new properties and values
  */
 Dygraph.prototype.updateOptions = function(attrs) {
@@ -3486,6 +3428,12 @@ Dygraph.prototype.updateOptions = function(attrs) {
   }
   if ('dateWindow' in attrs) {
     this.dateWindow_ = attrs.dateWindow;
+    if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
+      this.zoomed_x_ = attrs.dateWindow != null;
+    }
+  }
+  if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
+    this.zoomed_y_ = attrs.valueRange != null;
   }
 
   // TODO(danvk): validate per-series options.
@@ -4179,6 +4127,12 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
     "type": "integer",
     "default": "18",
     "description": "Width of the div which contains the y-axis label. Since the y-axis label appears rotated 90 degrees, this actually affects the height of its div."
+  },
+  "isZoomedIgnoreProgrammaticZoom" : {
+    "default": "false",
+    "labels": ["Zooming"],
+    "type": "boolean",
+    "description" : "When this option is passed to updateOptions() along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state. This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this."
   }
 }
 ;  // </JSON>
@@ -4205,7 +4159,8 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
    'Legend',
    'Overall display',
    'Rolling Averages',
-   'Value display/formatting'
+   'Value display/formatting',
+   'Zooming'
   ];
   var cats = {};
   for (var i = 0; i < valid_cats.length; i++) cats[valid_cats[i]] = true;