Move KMB/KMG2 formatting into default formatter function (issue 414)
[dygraphs.git] / auto_tests / tests / axis_labels.js
index 9b36565..787a3c3 100644 (file)
@@ -12,16 +12,12 @@ AxisLabelsTestCase.prototype.setUp = function() {
 AxisLabelsTestCase.prototype.tearDown = function() {
 };
 
-/**
- * Takes in an array of strings and returns an array of floats.
- */
-function makeNumbers(ary) {
-  var ret = [];
-  for (var i = 0; i < ary.length; i++) {
-    ret.push(parseFloat(ary[i]));
-  }
-  return ret;
-}
+AxisLabelsTestCase.simpleData =
+    "X,Y,Y2\n" +
+    "0,-1,.5\n" +
+    "1,0,.7\n" +
+    "2,1,.4\n" +
+    "3,0,.98\n";
 
 AxisLabelsTestCase.prototype.kCloseFloat = 1.0e-10;
 
@@ -59,7 +55,7 @@ AxisLabelsTestCase.prototype.testMinusOneToOne = function() {
   assertEquals(['0','20','40','60','80','100'], Util.getYLabels());
 
   g.setSelection(0);
-  assertEquals('0: Y:-1', Util.getLegend());
+  assertEquals('0: Y: -1', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testSmallRangeNearZero = function() {
@@ -78,21 +74,21 @@ AxisLabelsTestCase.prototype.testSmallRangeNearZero = function() {
 
   var graph = document.getElementById("graph");
   var g = new Dygraph(graph, data, opts);
-  assertEqualsDelta(makeNumbers(["-0.1","-0.08","-0.06","-0.04","-0.02","0","0.02","0.04","0.06","0.08"]),
-                    makeNumbers(Util.getYLabels()), this.kCloseFloat);
+  assertEqualsDelta([-0.1, -0.08, -0.06, -0.04, -0.02, 0, 0.02, 0.04, 0.06, 0.08],
+                    Util.makeNumbers(Util.getYLabels()), this.kCloseFloat);
 
   opts.valueRange = [-0.05, 0.05];
   g.updateOptions(opts);
-  // TODO(danvk): why '1.00e-2' and not '0.01'?
-  assertEquals(makeNumbers(["-0.05","-0.04","-0.03","-0.02","-0.01","0","1.00e-2","0.02","0.03","0.04"]),
-               makeNumbers(Util.getYLabels()));
+  assertEquals([-0.05, -0.04, -0.03, -0.02, -0.01, 0, 0.01, 0.02, 0.03, 0.04],
+               Util.makeNumbers(Util.getYLabels()));
 
   opts.valueRange = [-0.01, 0.01];
   g.updateOptions(opts);
-  assertEquals(makeNumbers(["-0.01","-8.00e-3","-6.00e-3","-4.00e-3","-2.00e-3","0","2.00e-3","4.00e-3","6.00e-3","8.00e-3"]), makeNumbers(Util.getYLabels()));
+  assertEquals([-0.01, -8.00e-3, -6.00e-3, -4.00e-3, -2.00e-3, 0, 2.00e-3, 4.00e-3, 6.00e-3, 8.00e-3],
+               Util.makeNumbers(Util.getYLabels()));
 
   g.setSelection(1);
-  assertEquals('1: Y:0', Util.getLegend());
+  assertEquals('1: Y: 0', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testSmallRangeAwayFromZero = function() {
@@ -123,7 +119,7 @@ AxisLabelsTestCase.prototype.testSmallRangeAwayFromZero = function() {
   assertEquals(["10","10","10","10","10","10","10","10","10","10"], Util.getYLabels());
 
   g.setSelection(1);
-  assertEquals('1: Y:0', Util.getLegend());
+  assertEquals('1: Y: 0', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testXAxisTimeLabelFormatter = function() {
@@ -156,7 +152,7 @@ AxisLabelsTestCase.prototype.testXAxisTimeLabelFormatter = function() {
 
   // The legend does not use the axisLabelFormatter:
   g.setSelection(1);
-  assertEquals('5.1: Y1:1', Util.getLegend());
+  assertEquals('5.1: Y1: 1', Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testAxisLabelFormatter = function () {
@@ -196,7 +192,7 @@ AxisLabelsTestCase.prototype.testAxisLabelFormatter = function () {
   assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(2);
-  assertEquals("2: y:4", Util.getLegend());
+  assertEquals("2: y: 4", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testDateAxisLabelFormatter = function () {
@@ -236,7 +232,7 @@ AxisLabelsTestCase.prototype.testDateAxisLabelFormatter = function () {
   assertEquals(['y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(0);
-  assertEquals("2011/01/01: y:2", Util.getLegend());
+  assertEquals("2011/01/01: y: 2", Util.getLegend());
 };
 
 // This test verifies that when a valueFormatter is set (but not an
@@ -282,7 +278,7 @@ AxisLabelsTestCase.prototype.testValueFormatter = function () {
 
   // they do affect the legend, however.
   g.setSelection(2);
-  assertEquals("x2: y:y4", Util.getLegend());
+  assertEquals("x2: y: y4", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testDateValueFormatter = function () {
@@ -325,7 +321,7 @@ AxisLabelsTestCase.prototype.testDateValueFormatter = function () {
 
   // the valueFormatter options also affect the legend.
   g.setSelection(2);
-  assertEquals('x2011/01/03: y:y6', Util.getLegend());
+  assertEquals('x2011/01/03: y: y6', Util.getLegend());
 };
 
 // This test verifies that when both a valueFormatter and an axisLabelFormatter
@@ -365,7 +361,7 @@ AxisLabelsTestCase.prototype.testAxisLabelFormatterPrecedence = function () {
   assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("xvf9: y:yvf18", Util.getLegend());
+  assertEquals("xvf9: y: yvf18", Util.getLegend());
 };
 
 // This is the same as the previous test, except that options are added
@@ -423,7 +419,7 @@ AxisLabelsTestCase.prototype.testAxisLabelFormatterIncremental = function () {
   assertEquals(['y0','y2','y4','y6','y8','y10','y12','y14','y16','y18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("xvf9: y:yvf18", Util.getLegend());
+  assertEquals("xvf9: y: yvf18", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testGlobalFormatters = function() {
@@ -449,7 +445,7 @@ AxisLabelsTestCase.prototype.testGlobalFormatters = function() {
   assertEquals(['alf0','alf2','alf4','alf6','alf8','alf10','alf12','alf14','alf16','alf18'], Util.getYLabels());
 
   g.setSelection(9);
-  assertEquals("vf9: y:vf18", Util.getLegend());
+  assertEquals("vf9: y: vf18", Util.getLegend());
 };
 
 AxisLabelsTestCase.prototype.testSeriesOrder = function() {
@@ -468,7 +464,7 @@ AxisLabelsTestCase.prototype.testSeriesOrder = function() {
   var g = new Dygraph(graph, data, opts);
 
   g.setSelection(2);
-  assertEquals('2: 00:103 01:203 10:303 11:403', Util.getLegend());
+  assertEquals('2: 00: 103 01: 203 10: 303 11: 403', Util.getLegend());
 
   // Sanity checks for indexFromSetName
   assertEquals(0, g.indexFromSetName("x"));
@@ -478,3 +474,279 @@ AxisLabelsTestCase.prototype.testSeriesOrder = function() {
   // Verify that we get the label list back in the right order
   assertEquals(["x", "00", "01", "10", "11"], g.getLabels());
 };
+
+AxisLabelsTestCase.prototype.testLabelKMB = function() {
+  var data = [];
+  data.push([0,0]);
+  data.push([1,2000]);
+  data.push([2,1000]);
+
+  var g = new Dygraph(
+    document.getElementById("graph"),
+    data,
+    {
+      labels: [ 'X', 'bar' ],
+      axes : {
+        y: {
+          labelsKMB: true
+        }
+      }
+    }
+  );
+
+  assertEquals(["0", "500", "1K", "1.5K", "2K"], Util.getYLabels());
+};
+
+AxisLabelsTestCase.prototype.testLabelKMG2 = function() {
+  var data = [];
+  data.push([0,0]);
+  data.push([1,2000]);
+  data.push([2,1000]);
+
+  var g = new Dygraph(
+    document.getElementById("graph"),
+    data,
+    {
+      labels: [ 'X', 'bar' ],
+      axes : {
+        y: {
+          labelsKMG2: true
+        }
+      }
+    }
+  );
+
+  assertEquals(
+      ["0","256","512","768","1k","1.25k","1.5k","1.75k","2k"],
+      Util.getYLabels());
+};
+
+// Same sa testLabelKMG2 but specifies the option at the
+// top of the option dictionary.
+AxisLabelsTestCase.prototype.testLabelKMG2_top = function() {
+  var data = [];
+  data.push([0,0]);
+  data.push([1,2000]);
+  data.push([2,1000]);
+
+  var g = new Dygraph(
+    document.getElementById("graph"),
+    data,
+    {
+      labels: [ 'X', 'bar' ],
+      labelsKMG2: true
+    }
+  );
+
+  assertEquals(
+      ["0","256","512","768","1k","1.25k","1.5k","1.75k","2k"],
+      Util.getYLabels());
+};
+
+/**
+ * Verify that log scale axis range is properly specified.
+ */
+AxisLabelsTestCase.prototype.testLogScale = function() {
+  var g = new Dygraph("graph", [[0, 5], [1, 1000]], { logscale : true });
+  var nonEmptyLabels = Util.getYLabels().filter(function(x) { return x.length > 0; });
+  assertEquals(["6","10","30","60","100","300","600","1000"], nonEmptyLabels);
+  g.updateOptions({ logscale : false });
+  assertEquals(['0','200','400','600','800','1000'], Util.getYLabels());
+}
+
+/**
+ * Verify that include zero range is properly specified.
+ */
+AxisLabelsTestCase.prototype.testIncludeZero = function() {
+  var g = new Dygraph("graph", [[0, 500], [1, 1000]], { includeZero : true });
+  assertEquals(['0','200','400','600','800','1000'], Util.getYLabels());
+  g.updateOptions({ includeZero : false });
+  assertEquals(['500','600','700','800','900','1000'], Util.getYLabels());
+}
+
+AxisLabelsTestCase.prototype.testAxisLabelFontSize = function() {
+  var graph = document.getElementById("graph");
+  var g = new Dygraph(graph, AxisLabelsTestCase.simpleData, {});
+
+  // Be sure we're dealing with a 14-point default.
+  assertEquals(14, Dygraph.DEFAULT_ATTRS.axisLabelFontSize);
+
+  var assertFontSize = function(selector, expected) {
+    Util.assertStyleOfChildren(selector, "font-size", expected);
+  }
+  
+  assertFontSize($(".dygraph-axis-label-x"), "14px");
+  assertFontSize($(".dygraph-axis-label-y") , "14px");
+
+  g.updateOptions({ axisLabelFontSize : 8});
+  assertFontSize($(".dygraph-axis-label-x"), "8px"); 
+  assertFontSize($(".dygraph-axis-label-y"), "8px"); 
+
+  g.updateOptions({
+    axisLabelFontSize : null,
+    axes : { 
+      x : { axisLabelFontSize : 5 },
+    }   
+  }); 
+
+  assertFontSize($(".dygraph-axis-label-x"), "5px"); 
+  assertFontSize($(".dygraph-axis-label-y"), "14px");
+
+  g.updateOptions({
+    axes : { 
+      y : { axisLabelFontSize : 20 },
+    }   
+  }); 
+
+  assertFontSize($(".dygraph-axis-label-x"), "5px"); 
+  assertFontSize($(".dygraph-axis-label-y"), "20px"); 
+
+  g.updateOptions({
+    series : { 
+      Y2 : { axis : "y2" } // copy y2 series to y2 axis.
+    },  
+    axes : { 
+      y2 : { axisLabelFontSize : 12 },
+    }   
+  }); 
+
+  assertFontSize($(".dygraph-axis-label-x"), "5px"); 
+  assertFontSize($(".dygraph-axis-label-y1"), "20px"); 
+  assertFontSize($(".dygraph-axis-label-y2"), "12px"); 
+}
+
+AxisLabelsTestCase.prototype.testAxisLabelFontSizeNull = function() {
+  var graph = document.getElementById("graph");
+  var g = new Dygraph(graph, AxisLabelsTestCase.simpleData,
+    {
+      axisLabelFontSize: null
+    });
+
+  var assertFontSize = function(selector, expected) {
+    Util.assertStyleOfChildren(selector, "font-size", expected);
+  };
+
+  // Be sure we're dealing with a 14-point default.
+  assertEquals(14, Dygraph.DEFAULT_ATTRS.axisLabelFontSize);
+
+  assertFontSize($(".dygraph-axis-label-x"), "14px");
+  assertFontSize($(".dygraph-axis-label-y"), "14px");
+}
+
+AxisLabelsTestCase.prototype.testAxisLabelColor = function() {
+  var graph = document.getElementById("graph");
+  var g = new Dygraph(graph, AxisLabelsTestCase.simpleData, {});
+
+  // Be sure we're dealing with a black default.
+  assertEquals("black", Dygraph.DEFAULT_ATTRS.axisLabelColor);
+
+  var assertColor = function(selector, expected) {
+    Util.assertStyleOfChildren(selector, "color", expected);
+  }
+
+  assertColor($(".dygraph-axis-label-x"), "rgb(0, 0, 0)");
+  assertColor($(".dygraph-axis-label-y"), "rgb(0, 0, 0)");
+
+  g.updateOptions({ axisLabelColor : "red"});
+  assertColor($(".dygraph-axis-label-x"), "rgb(255, 0, 0)"); 
+  assertColor($(".dygraph-axis-label-y"), "rgb(255, 0, 0)"); 
+
+  g.updateOptions({
+    axisLabelColor : null,
+    axes : { 
+      x : { axisLabelColor : "blue" },
+    }   
+  }); 
+
+  assertColor($(".dygraph-axis-label-x"), "rgb(0, 0, 255)"); 
+  assertColor($(".dygraph-axis-label-y"), "rgb(0, 0, 0)");
+
+  g.updateOptions({
+    axes : { 
+      y : { axisLabelColor : "green" },
+    }   
+  }); 
+
+  assertColor($(".dygraph-axis-label-x"), "rgb(0, 0, 255)"); 
+  assertColor($(".dygraph-axis-label-y"), "rgb(0, 128, 0)"); 
+
+  g.updateOptions({
+    series : { 
+      Y2 : { axis : "y2" } // copy y2 series to y2 axis.
+    },  
+    axes : { 
+      y2 : { axisLabelColor : "yellow" },
+    }   
+  }); 
+
+  assertColor($(".dygraph-axis-label-x"), "rgb(0, 0, 255)"); 
+  assertColor($(".dygraph-axis-label-y1"), "rgb(0, 128, 0)"); 
+  assertColor($(".dygraph-axis-label-y2"), "rgb(255, 255, 0)"); 
+}
+
+AxisLabelsTestCase.prototype.testAxisLabelColorNull = function() {
+  var graph = document.getElementById("graph");
+  var g = new Dygraph(graph, AxisLabelsTestCase.simpleData,
+    {
+      axisLabelColor: null
+    });
+
+  var assertColor = function(selector, expected) {
+    Util.assertStyleOfChildren(selector, "color", expected);
+  }
+
+  // Be sure we're dealing with a 14-point default.
+  assertEquals(14, Dygraph.DEFAULT_ATTRS.axisLabelFontSize);
+
+  assertColor($(".dygraph-axis-label-x"), "rgb(0, 0, 0)");
+  assertColor($(".dygraph-axis-label-y"), "rgb(0, 0, 0)");
+}
+
+/*
+ * This test shows that the label formatter overrides labelsKMB for all values.
+ */
+AxisLabelsTestCase.prototype.testLabelFormatterOverridesLabelsKMB = function() {
+  var g = new Dygraph(
+      document.getElementById("graph"),
+      "X,a,b\n" +
+      "1,0,2000\n" +
+      "2,500,1500\n" +
+      "3,1000,1000\n" +
+      "4,2000,0\n", {
+        labelsKMB: true,
+        axisLabelFormatter: function (v) {
+          return v + ":X";
+        }
+      });
+  assertEquals(["0:X","500:X","1000:X","1500:X","2000:X"], Util.getYLabels());
+  assertEquals(["1:X","1.5:X","2:X","2.5:X","3:X","3.5:X"], Util.getXLabels());
+}
+
+/*
+ * This test shows that you can override labelsKMB on the axis level.
+ */
+AxisLabelsTestCase.prototype.testLabelsKMBIgnoredWhenOverridden = function() {
+  g = new Dygraph(
+      document.getElementById("graph"),
+      "x,a,b\n" +
+      "1,0,2000\n" +
+      "2,500,1500\n" +
+      "3,1000,1000\n" +
+      "4,2000,0\n", {
+        labelsKMB: true,
+        axes: {
+          y2: {
+            labelsKMB: false
+          }
+        },
+        series: {
+          b: {
+            axis: "y2"
+          },
+        }
+      });
+  assertEquals(["0","500","1K","1.5K","2K"], Util.getYLabels(1));
+  assertEquals(["0","500","1000","1500","2000"], Util.getYLabels(2));
+};