[dygraphs.git] / auto_tests / tests / axis_labels-deprecated.js

/**
 * @fileoverview Test cases for how axis labels are chosen and formatted,
 * specializing on the deprecated xLabelFormatter, etc.
 *
 * @author dan@dygraphs.com (Dan Vanderkam)
 */
var DeprecatedAxisLabelsTestCase = TestCase("axis-labels-deprecated");

DeprecatedAxisLabelsTestCase.prototype.setUp = function() {
  document.body.innerHTML = "<div id='graph'></div>";
};

DeprecatedAxisLabelsTestCase.prototype.tearDown = function() {
};

DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDeprecatedXAxisTimeLabelFormatter = function() {
  var opts = {
    width: 480,
    height: 320
  };
  var data = [[5.0,0],[5.1,1],[5.2,2],[5.3,3],[5.4,4],[5.5,5],[5.6,6],[5.7,7],[5.8,8],[5.9,9]];
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);
  g.updateOptions({
    axes : {
      x : {
        axisLabelFormatter: function (totalMinutes) {
          var hours   = Math.floor( totalMinutes / 60);
          var minutes = Math.floor((totalMinutes - (hours * 60)));
          var seconds = Math.round((totalMinutes * 60) - (hours * 3600) - (minutes * 60));

          if (hours   < 10) hours   = "0" + hours;
          if (minutes < 10) minutes = "0" + minutes;
          if (seconds < 10) seconds = "0" + seconds;

          return hours + ':' + minutes + ':' + seconds;
        }
      }
    }
  });

  assertEquals(["00:05:00","00:05:12","00:05:24","00:05:36","00:05:48"], Util.getXLabels());

  // The legend does not use the xAxisLabelFormatter:
  g.setSelection(1);
  assertEquals('5.1: Y1: 1', Util.getLegend());
};

DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatter = function () {
  var opts = {
    width: 480,
    height: 320,
    axes : {
      x : {
        axisLabelFormatter: function(x, granularity, opts, dg) {
          assertEquals('number', typeof(x));
          assertEquals('number', typeof(granularity));
          assertEquals('function', typeof(opts));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'x' + x;
        }
      },
      y : {
        axisLabelFormatter: function(y, granularity, opts, dg) {
          assertEquals('number', typeof(y));
          assertEquals('number', typeof(granularity));
          assertEquals('function', typeof(opts));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'y' + y;
        }
      }
    },
    labels: ['x', 'y']
  };
  var data = [];
  for (var i = 0; i < 10; i++) {
    data.push([i, 2 * i]);
  }
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);

  assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
  assertEquals(["y0","y5","y10","y15"], Util.getYLabels());

  g.setSelection(2);
  assertEquals("2: y: 4", Util.getLegend());
};

DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateAxisLabelFormatter = function () {
  var opts = {
    width: 480,
    height: 320,
    axes : {
      x : {
        axisLabelFormatter: function(x, granularity, opts, dg) {
          assertTrue(Dygraph.isDateLike(x));
          assertEquals('number', typeof(granularity));
          assertEquals('function', typeof(opts));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'x' + Util.formatDate(x);
        },
        pixelsPerLabel: 60
      },
      y : {
        axisLabelFormatter: function(y, granularity, opts, dg) {
          assertEquals('number', typeof(y));
          assertEquals('number', typeof(granularity));
          assertEquals('function', typeof(opts));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'y' + y;
        }
      }
    },
    labels: ['x', 'y']
  };
  var data = [];
  for (var i = 1; i < 10; i++) {
    data.push([new Date("2011/01/0" + i), 2 * i]);
  }
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);

  assertEquals(["x2011/01/02","x2011/01/04","x2011/01/06","x2011/01/08"], Util.getXLabels());
  assertEquals(["y5","y10","y15"], Util.getYLabels());

  g.setSelection(0);
  assertEquals("2011/01/01: y: 2", Util.getLegend());
};

// This test verifies that when a valueFormatter is set (but not an
// axisLabelFormatter), then the valueFormatter is used to format the axis
// labels.
DeprecatedAxisLabelsTestCase.prototype.testDeprecatedValueFormatter = function () {
  var opts = {
    width: 480,
    height: 320,
    axes : {
      x : {
        valueFormatter: function(x, opts, series_name, dg) {
          assertEquals('number', typeof(x));
          assertEquals('function', typeof(opts));
          assertEquals('string', typeof(series_name));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'x' + x;
        }
      },
      y : {
        valueFormatter: function(y, opts, series_name, dg) {
          assertEquals('number', typeof(y));
          assertEquals('function', typeof(opts));
          assertEquals('string', typeof(series_name));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'y' + y;
        }
      }
    },
    labels: ['x', 'y']
  };
  var data = [];
  for (var i = 0; i < 10; i++) {
    data.push([i, 2 * i]);
  }
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);

  // the valueFormatter options do not affect the ticks.
  assertEquals(['0','2','4','6','8'], Util.getXLabels());
  assertEquals(["0","5","10","15"], Util.getYLabels());

  // they do affect the legend, however.
  g.setSelection(2);
  assertEquals("x2: y: y4", Util.getLegend());
};

DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateValueFormatter = function () {
  var opts = {
    width: 480,
    height: 320,
    axes : {
      x : {
        valueFormatter: function(x, opts, series_name, dg) {
          assertEquals('number', typeof(x));
          assertEquals('function', typeof(opts));
          assertEquals('string', typeof(series_name));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'x' + Util.formatDate(x);
        },
        pixelsPerLabel: 60
      },
      y : {
        valueFormatter: function(y, opts, series_name, dg) {
          assertEquals('number', typeof(y));
          assertEquals('function', typeof(opts));
          assertEquals('string', typeof(series_name));
          assertEquals('[Dygraph graph]', dg.toString());
          return 'y' + y;
        }
      }
    },
    labels: ['x', 'y']
  };

  var data = [];
  for (var i = 1; i < 10; i++) {
    data.push([new Date("2011/01/0" + i), 2 * i]);
  }
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);

  // valueFormatters do not affect ticks.
  assertEquals(["02 Jan","04 Jan","06 Jan","08 Jan"], Util.getXLabels());
  assertEquals(["5","10","15"], Util.getYLabels());

  // the valueFormatter options also affect the legend.
  g.setSelection(2);
  assertEquals('x2011/01/03: y: y6', Util.getLegend());
};

// This test verifies that when both a valueFormatter and an axisLabelFormatter
// are specified, the axisLabelFormatter takes precedence.
DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatterPrecedence = function () {
  var opts = {
    width: 480,
    height: 320,
    axes : {
      x : {
        valueFormatter: function(x) {
          return 'xvf' + x;
        },
        axisLabelFormatter: function(x, granularity) {
          return 'x' + x;
        },
      },
      y : {
        valueFormatter: function(y) {
          return 'yvf' + y;
        },
        axisLabelFormatter: function(y) {
          return 'y' + y;
        },
      }
    },
    labels: ['x', 'y']
  };
  var data = [];
  for (var i = 0; i < 10; i++) {
    data.push([i, 2 * i]);
  }
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);

  assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
  assertEquals(["y0","y5","y10","y15"], Util.getYLabels());

  g.setSelection(9);
  assertEquals("xvf9: y: yvf18", Util.getLegend());
};

// This is the same as the previous test, except that options are added
// one-by-one.
DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatterIncremental = function () {
  var opts = {
    width: 480,
    height: 320,
    labels: ['x', 'y']
  };
  var data = [];
  for (var i = 0; i < 10; i++) {
    data.push([i, 2 * i]);
  }
  var graph = document.getElementById("graph");
  var g = new Dygraph(graph, data, opts);
  g.updateOptions({
    axes : {
      x : { 
        valueFormatter: function(x) {
          return 'xvf' + x;
        }
      }
    }
  });
  g.updateOptions({
    axes : {
      y : { 
        valueFormatter: function(y) {
          return 'yvf' + y;
        }
      }
    }
  });
  g.updateOptions({
    axes : {
      x : { 
        axisLabelFormatter: function(x) {
          return 'x' + x;
        }
      }
    }
  });
  g.updateOptions({
    axes : {
      y : { 
        axisLabelFormatter: function(y) {
          return 'y' + y;
        }
      }
    }
  });

  assertEquals(["x0","x2","x4","x6","x8"], Util.getXLabels());
  assertEquals(["y0","y5","y10","y15"], Util.getYLabels());

  g.setSelection(9);
  assertEquals("xvf9: y: yvf18", Util.getLegend());
};
Commit	Line	Data
48e614ac	1	/**
6d6c60b6 RK	2	* @fileoverview Test cases for how axis labels are chosen and formatted,
6d6c60b6 RK	3	* specializing on the deprecated xLabelFormatter, etc.
f3cbe61e DV	4	*
	5	* @author dan@dygraphs.com (Dan Vanderkam)
	6	*/
6d6c60b6	7	var DeprecatedAxisLabelsTestCase = TestCase("axis-labels-deprecated");
f3cbe61e	8
6d6c60b6	9	DeprecatedAxisLabelsTestCase.prototype.setUp = function() {
f3cbe61e DV	10	document.body.innerHTML = "<div id='graph'></div>";
	11	};
	12
6d6c60b6	13	DeprecatedAxisLabelsTestCase.prototype.tearDown = function() {
f3cbe61e DV	14	};
f3cbe61e DV	15
8fcf1b16	16	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDeprecatedXAxisTimeLabelFormatter = function() {
ad69cb8a DV	17	var opts = {
	18	width: 480,
	19	height: 320
	20	};
	21	var data = [[5.0,0],[5.1,1],[5.2,2],[5.3,3],[5.4,4],[5.5,5],[5.6,6],[5.7,7],[5.8,8],[5.9,9]];
	22	var graph = document.getElementById("graph");
	23	var g = new Dygraph(graph, data, opts);
	24	g.updateOptions({
bfb3e0a4 RK	25	axes : {
	26	x : {
	27	axisLabelFormatter: function (totalMinutes) {
	28	var hours = Math.floor( totalMinutes / 60);
	29	var minutes = Math.floor((totalMinutes - (hours * 60)));
	30	var seconds = Math.round((totalMinutes * 60) - (hours * 3600) - (minutes * 60));
ad69cb8a	31
bfb3e0a4 RK	32	if (hours < 10) hours = "0" + hours;
	33	if (minutes < 10) minutes = "0" + minutes;
	34	if (seconds < 10) seconds = "0" + seconds;
ad69cb8a	35
bfb3e0a4 RK	36	return hours + ':' + minutes + ':' + seconds;
	37	}
	38	}
ad69cb8a DV	39	}
ad69cb8a DV	40	});
97889da4	41
846038aa	42	assertEquals(["00:05:00","00:05:12","00:05:24","00:05:36","00:05:48"], Util.getXLabels());
48e614ac DV	43
	44	// The legend does not use the xAxisLabelFormatter:
	45	g.setSelection(1);
79aabc9d	46	assertEquals('5.1: Y1: 1', Util.getLegend());
48e614ac DV	47	};
48e614ac DV	48
8fcf1b16	49	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatter = function () {
48e614ac DV	50	var opts = {
	51	width: 480,
	52	height: 320,
bfb3e0a4 RK	53	axes : {
	54	x : {
	55	axisLabelFormatter: function(x, granularity, opts, dg) {
	56	assertEquals('number', typeof(x));
	57	assertEquals('number', typeof(granularity));
	58	assertEquals('function', typeof(opts));
	59	assertEquals('[Dygraph graph]', dg.toString());
	60	return 'x' + x;
	61	}
	62	},
	63	y : {
	64	axisLabelFormatter: function(y, granularity, opts, dg) {
	65	assertEquals('number', typeof(y));
	66	assertEquals('number', typeof(granularity));
	67	assertEquals('function', typeof(opts));
	68	assertEquals('[Dygraph graph]', dg.toString());
	69	return 'y' + y;
	70	}
	71	}
48e614ac DV	72	},
	73	labels: ['x', 'y']
	74	};
	75	var data = [];
	76	for (var i = 0; i < 10; i++) {
	77	data.push([i, 2 * i]);
	78	}
	79	var graph = document.getElementById("graph");
	80	var g = new Dygraph(graph, data, opts);
	81
846038aa	82	assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
d7aa8aa5	83	assertEquals(["y0","y5","y10","y15"], Util.getYLabels());
48e614ac DV	84
48e614ac DV	85	g.setSelection(2);
79aabc9d	86	assertEquals("2: y: 4", Util.getLegend());
48e614ac DV	87	};
48e614ac DV	88
8fcf1b16	89	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateAxisLabelFormatter = function () {
48e614ac DV	90	var opts = {
	91	width: 480,
	92	height: 320,
bfb3e0a4 RK	93	axes : {
	94	x : {
	95	axisLabelFormatter: function(x, granularity, opts, dg) {
	96	assertTrue(Dygraph.isDateLike(x));
	97	assertEquals('number', typeof(granularity));
	98	assertEquals('function', typeof(opts));
	99	assertEquals('[Dygraph graph]', dg.toString());
	100	return 'x' + Util.formatDate(x);
	101	},
	102	pixelsPerLabel: 60
	103	},
	104	y : {
	105	axisLabelFormatter: function(y, granularity, opts, dg) {
	106	assertEquals('number', typeof(y));
	107	assertEquals('number', typeof(granularity));
	108	assertEquals('function', typeof(opts));
	109	assertEquals('[Dygraph graph]', dg.toString());
	110	return 'y' + y;
	111	}
	112	}
e0269a3d	113	},
48e614ac DV	114	labels: ['x', 'y']
	115	};
	116	var data = [];
	117	for (var i = 1; i < 10; i++) {
	118	data.push([new Date("2011/01/0" + i), 2 * i]);
	119	}
	120	var graph = document.getElementById("graph");
	121	var g = new Dygraph(graph, data, opts);
	122
64b7098e	123	assertEquals(["x2011/01/02","x2011/01/04","x2011/01/06","x2011/01/08"], Util.getXLabels());
d7aa8aa5	124	assertEquals(["y5","y10","y15"], Util.getYLabels());
48e614ac DV	125
48e614ac DV	126	g.setSelection(0);
79aabc9d	127	assertEquals("2011/01/01: y: 2", Util.getLegend());
48e614ac DV	128	};
	129
	130	// This test verifies that when a valueFormatter is set (but not an
	131	// axisLabelFormatter), then the valueFormatter is used to format the axis
	132	// labels.
8fcf1b16	133	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedValueFormatter = function () {
48e614ac DV	134	var opts = {
	135	width: 480,
	136	height: 320,
bfb3e0a4 RK	137	axes : {
	138	x : {
	139	valueFormatter: function(x, opts, series_name, dg) {
	140	assertEquals('number', typeof(x));
	141	assertEquals('function', typeof(opts));
	142	assertEquals('string', typeof(series_name));
	143	assertEquals('[Dygraph graph]', dg.toString());
	144	return 'x' + x;
	145	}
	146	},
	147	y : {
	148	valueFormatter: function(y, opts, series_name, dg) {
	149	assertEquals('number', typeof(y));
	150	assertEquals('function', typeof(opts));
	151	assertEquals('string', typeof(series_name));
	152	assertEquals('[Dygraph graph]', dg.toString());
	153	return 'y' + y;
	154	}
	155	}
48e614ac DV	156	},
	157	labels: ['x', 'y']
	158	};
	159	var data = [];
	160	for (var i = 0; i < 10; i++) {
	161	data.push([i, 2 * i]);
	162	}
	163	var graph = document.getElementById("graph");
	164	var g = new Dygraph(graph, data, opts);
	165
	166	// the valueFormatter options do not affect the ticks.
846038aa	167	assertEquals(['0','2','4','6','8'], Util.getXLabels());
d7aa8aa5	168	assertEquals(["0","5","10","15"], Util.getYLabels());
48e614ac DV	169
	170	// they do affect the legend, however.
	171	g.setSelection(2);
79aabc9d	172	assertEquals("x2: y: y4", Util.getLegend());
48e614ac DV	173	};
48e614ac DV	174
8fcf1b16	175	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedDateValueFormatter = function () {
48e614ac DV	176	var opts = {
	177	width: 480,
	178	height: 320,
bfb3e0a4 RK	179	axes : {
	180	x : {
	181	valueFormatter: function(x, opts, series_name, dg) {
	182	assertEquals('number', typeof(x));
	183	assertEquals('function', typeof(opts));
	184	assertEquals('string', typeof(series_name));
	185	assertEquals('[Dygraph graph]', dg.toString());
	186	return 'x' + Util.formatDate(x);
	187	},
	188	pixelsPerLabel: 60
	189	},
	190	y : {
	191	valueFormatter: function(y, opts, series_name, dg) {
	192	assertEquals('number', typeof(y));
	193	assertEquals('function', typeof(opts));
	194	assertEquals('string', typeof(series_name));
	195	assertEquals('[Dygraph graph]', dg.toString());
	196	return 'y' + y;
	197	}
	198	}
48e614ac	199	},
48e614ac DV	200	labels: ['x', 'y']
	201	};
	202
	203	var data = [];
	204	for (var i = 1; i < 10; i++) {
	205	data.push([new Date("2011/01/0" + i), 2 * i]);
	206	}
	207	var graph = document.getElementById("graph");
	208	var g = new Dygraph(graph, data, opts);
	209
	210	// valueFormatters do not affect ticks.
64b7098e	211	assertEquals(["02 Jan","04 Jan","06 Jan","08 Jan"], Util.getXLabels());
d7aa8aa5	212	assertEquals(["5","10","15"], Util.getYLabels());
48e614ac DV	213
	214	// the valueFormatter options also affect the legend.
	215	g.setSelection(2);
79aabc9d	216	assertEquals('x2011/01/03: y: y6', Util.getLegend());
48e614ac DV	217	};
	218
	219	// This test verifies that when both a valueFormatter and an axisLabelFormatter
	220	// are specified, the axisLabelFormatter takes precedence.
8fcf1b16	221	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatterPrecedence = function () {
48e614ac DV	222	var opts = {
	223	width: 480,
	224	height: 320,
bfb3e0a4 RK	225	axes : {
	226	x : {
	227	valueFormatter: function(x) {
	228	return 'xvf' + x;
	229	},
	230	axisLabelFormatter: function(x, granularity) {
	231	return 'x' + x;
	232	},
	233	},
	234	y : {
	235	valueFormatter: function(y) {
	236	return 'yvf' + y;
	237	},
	238	axisLabelFormatter: function(y) {
	239	return 'y' + y;
	240	},
	241	}
48e614ac DV	242	},
	243	labels: ['x', 'y']
	244	};
	245	var data = [];
	246	for (var i = 0; i < 10; i++) {
	247	data.push([i, 2 * i]);
	248	}
	249	var graph = document.getElementById("graph");
	250	var g = new Dygraph(graph, data, opts);
	251
846038aa	252	assertEquals(['x0','x2','x4','x6','x8'], Util.getXLabels());
d7aa8aa5	253	assertEquals(["y0","y5","y10","y15"], Util.getYLabels());
48e614ac DV	254
48e614ac DV	255	g.setSelection(9);
79aabc9d	256	assertEquals("xvf9: y: yvf18", Util.getLegend());
48e614ac DV	257	};
	258
	259	// This is the same as the previous test, except that options are added
	260	// one-by-one.
8fcf1b16	261	DeprecatedAxisLabelsTestCase.prototype.testDeprecatedAxisLabelFormatterIncremental = function () {
48e614ac DV	262	var opts = {
	263	width: 480,
	264	height: 320,
	265	labels: ['x', 'y']
	266	};
	267	var data = [];
	268	for (var i = 0; i < 10; i++) {
	269	data.push([i, 2 * i]);
	270	}
	271	var graph = document.getElementById("graph");
	272	var g = new Dygraph(graph, data, opts);
	273	g.updateOptions({
bfb3e0a4 RK	274	axes : {
	275	x : {
	276	valueFormatter: function(x) {
	277	return 'xvf' + x;
	278	}
	279	}
48e614ac DV	280	}
	281	});
	282	g.updateOptions({
bfb3e0a4 RK	283	axes : {
	284	y : {
	285	valueFormatter: function(y) {
	286	return 'yvf' + y;
	287	}
	288	}
48e614ac DV	289	}
	290	});
	291	g.updateOptions({
bfb3e0a4 RK	292	axes : {
	293	x : {
	294	axisLabelFormatter: function(x) {
	295	return 'x' + x;
	296	}
	297	}
48e614ac DV	298	}
	299	});
	300	g.updateOptions({
bfb3e0a4 RK	301	axes : {
	302	y : {
	303	axisLabelFormatter: function(y) {
	304	return 'y' + y;
	305	}
	306	}
48e614ac DV	307	}
	308	});
	309
846038aa	310	assertEquals(["x0","x2","x4","x6","x8"], Util.getXLabels());
d7aa8aa5	311	assertEquals(["y0","y5","y10","y15"], Util.getYLabels());
ad69cb8a	312
48e614ac	313	g.setSelection(9);
79aabc9d	314	assertEquals("xvf9: y: yvf18", Util.getLegend());
ad69cb8a	315	};