Merge pull request #250 from wimme/patch-4
[dygraphs.git] / dygraph-tickers.js
CommitLineData
88e95c46
DV
1/**
2 * @license
3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
48e614ac
DV
6
7/**
8 * @fileoverview Description of this file.
9 * @author danvk@google.com (Dan Vanderkam)
10 *
11 * A ticker is a function with the following interface:
12 *
13 * function(a, b, pixels, options_view, dygraph, forced_values);
14 * -> [ { v: tick1_v, label: tick1_label[, label_v: label_v1] },
15 * { v: tick2_v, label: tick2_label[, label_v: label_v2] },
16 * ...
17 * ]
18 *
19 * The returned value is called a "tick list".
20 *
21 * Arguments
22 * ---------
23 *
24 * [a, b] is the range of the axis for which ticks are being generated. For a
25 * numeric axis, these will simply be numbers. For a date axis, these will be
26 * millis since epoch (convertable to Date objects using "new Date(a)" and "new
27 * Date(b)").
28 *
29 * opts provides access to chart- and axis-specific options. It can be used to
30 * access number/date formatting code/options, check for a log scale, etc.
31 *
32 * pixels is the length of the axis in pixels. opts('pixelsPerLabel') is the
33 * minimum amount of space to be allotted to each label. For instance, if
34 * pixels=400 and opts('pixelsPerLabel')=40 then the ticker should return
35 * between zero and ten (400/40) ticks.
36 *
37 * dygraph is the Dygraph object for which an axis is being constructed.
38 *
39 * forced_values is used for secondary y-axes. The tick positions are typically
40 * set by the primary y-axis, so the secondary y-axis has no choice in where to
41 * put these. It simply has to generate labels for these data values.
42 *
43 * Tick lists
44 * ----------
45 * Typically a tick will have both a grid/tick line and a label at one end of
46 * that line (at the bottom for an x-axis, at left or right for the y-axis).
47 *
48 * A tick may be missing one of these two components:
49 * - If "label_v" is specified instead of "v", then there will be no tick or
50 * gridline, just a label.
51 * - Similarly, if "label" is not specified, then there will be a gridline
52 * without a label.
53 *
54 * This flexibility is useful in a few situations:
55 * - For log scales, some of the tick lines may be too close to all have labels.
56 * - For date scales where years are being displayed, it is desirable to display
57 * tick marks at the beginnings of years but labels (e.g. "2006") in the
58 * middle of the years.
59 */
60
83b0c192 61/*jshint globalstrict:true, sub:true */
758a629f 62/*global Dygraph:false */
c0f54d4f
DV
63"use strict";
64
b2867ee1 65/** @typedef {Array.<{v:number, label:string, label_v:(string|undefined)}>} */
0cd1ad15 66Dygraph.TickList = undefined; // the ' = undefined' keeps jshint happy.
b2867ee1
DV
67
68/** @typedef {function(
69 * number,
70 * number,
71 * number,
72 * function(string):*,
73 * Dygraph=,
74 * Array.<number>=
75 * ): Dygraph.TickList}
76 */
0cd1ad15 77Dygraph.Ticker = undefined; // the ' = undefined' keeps jshint happy.
b2867ee1
DV
78
79/** @type {Dygraph.Ticker} */
44462ba3
KW
80Dygraph.numericLinearTicks = function(a, b, pixels, opts, dygraph, vals) {
81 var nonLogscaleOpts = function(opt) {
82 if (opt === 'logscale') return false;
83 return opts(opt);
84 };
85 return Dygraph.numericTicks(a, b, pixels, nonLogscaleOpts, dygraph, vals);
86};
87
b2867ee1 88/** @type {Dygraph.Ticker} */
48e614ac 89Dygraph.numericTicks = function(a, b, pixels, opts, dygraph, vals) {
b2867ee1 90 var pixels_per_tick = /** @type{number} */(opts('pixelsPerLabel'));
48e614ac 91 var ticks = [];
758a629f 92 var i, j, tickV, nTicks;
48e614ac 93 if (vals) {
758a629f 94 for (i = 0; i < vals.length; i++) {
48e614ac
DV
95 ticks.push({v: vals[i]});
96 }
97 } else {
98 // TODO(danvk): factor this log-scale block out into a separate function.
99 if (opts("logscale")) {
758a629f 100 nTicks = Math.floor(pixels / pixels_per_tick);
48e614ac
DV
101 var minIdx = Dygraph.binarySearch(a, Dygraph.PREFERRED_LOG_TICK_VALUES, 1);
102 var maxIdx = Dygraph.binarySearch(b, Dygraph.PREFERRED_LOG_TICK_VALUES, -1);
103 if (minIdx == -1) {
104 minIdx = 0;
105 }
106 if (maxIdx == -1) {
107 maxIdx = Dygraph.PREFERRED_LOG_TICK_VALUES.length - 1;
108 }
109 // Count the number of tick values would appear, if we can get at least
110 // nTicks / 4 accept them.
111 var lastDisplayed = null;
112 if (maxIdx - minIdx >= nTicks / 4) {
113 for (var idx = maxIdx; idx >= minIdx; idx--) {
114 var tickValue = Dygraph.PREFERRED_LOG_TICK_VALUES[idx];
115 var pixel_coord = Math.log(tickValue / a) / Math.log(b / a) * pixels;
116 var tick = { v: tickValue };
758a629f 117 if (lastDisplayed === null) {
48e614ac
DV
118 lastDisplayed = {
119 tickValue : tickValue,
120 pixel_coord : pixel_coord
121 };
122 } else {
123 if (Math.abs(pixel_coord - lastDisplayed.pixel_coord) >= pixels_per_tick) {
124 lastDisplayed = {
125 tickValue : tickValue,
126 pixel_coord : pixel_coord
127 };
128 } else {
129 tick.label = "";
130 }
131 }
132 ticks.push(tick);
133 }
134 // Since we went in backwards order.
135 ticks.reverse();
136 }
137 }
138
139 // ticks.length won't be 0 if the log scale function finds values to insert.
758a629f 140 if (ticks.length === 0) {
48e614ac
DV
141 // Basic idea:
142 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
143 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
144 // The first spacing greater than pixelsPerYLabel is what we use.
145 // TODO(danvk): version that works on a log scale.
146 var kmg2 = opts("labelsKMG2");
fa0d7ad8 147 var mults, base;
48e614ac 148 if (kmg2) {
48f5d762 149 mults = [1, 2, 4, 8, 16, 32, 64, 128, 256];
fa0d7ad8 150 base = 16;
48e614ac 151 } else {
48f5d762 152 mults = [1, 2, 5, 10, 20, 50, 100];
fa0d7ad8 153 base = 10;
48e614ac 154 }
fa0d7ad8 155
48f5d762
KW
156 // Get the maximum number of permitted ticks based on the
157 // graph's pixel size and pixels_per_tick setting.
158 var max_ticks = Math.ceil(pixels / pixels_per_tick);
159
160 // Now calculate the data unit equivalent of this tick spacing.
161 // Use abs() since graphs may have a reversed Y axis.
162 var units_per_tick = Math.abs(b - a) / max_ticks;
163
164 // Based on this, get a starting scale which is the largest
165 // integer power of the chosen base (10 or 16) that still remains
166 // below the requested pixels_per_tick spacing.
fa0d7ad8
KW
167 var base_power = Math.floor(Math.log(units_per_tick) / Math.log(base));
168 var base_scale = Math.pow(base, base_power);
48f5d762
KW
169
170 // Now try multiples of the starting scale until we find one
171 // that results in tick marks spaced sufficiently far apart.
172 // The "mults" array should cover the range 1 .. base^2 to
173 // adjust for rounding and edge effects.
0cd1ad15 174 var scale, low_val, high_val, spacing;
fa0d7ad8
KW
175 for (j = 0; j < mults.length; j++) {
176 scale = base_scale * mults[j];
177 low_val = Math.floor(a / scale) * scale;
178 high_val = Math.ceil(b / scale) * scale;
179 nTicks = Math.abs(high_val - low_val) / scale;
180 spacing = pixels / nTicks;
48e614ac
DV
181 if (spacing > pixels_per_tick) break;
182 }
183
184 // Construct the set of ticks.
185 // Allow reverse y-axis if it's explicitly requested.
186 if (low_val > high_val) scale *= -1;
758a629f
DV
187 for (i = 0; i < nTicks; i++) {
188 tickV = low_val + i * scale;
48e614ac
DV
189 ticks.push( {v: tickV} );
190 }
191 }
192 }
193
d67a4279 194 var formatter = /**@type{AxisLabelFormatter}*/(opts('axisLabelFormatter'));
48e614ac
DV
195
196 // Add labels to the ticks.
758a629f 197 for (i = 0; i < ticks.length; i++) {
48e614ac 198 if (ticks[i].label !== undefined) continue; // Use current label.
48e614ac 199 // TODO(danvk): set granularity to something appropriate here.
2fd143d3 200 ticks[i].label = formatter(ticks[i].v, 0, opts, dygraph);
48e614ac
DV
201 }
202
203 return ticks;
204};
205
206
b2867ee1 207/** @type {Dygraph.Ticker} */
48e614ac 208Dygraph.dateTicker = function(a, b, pixels, opts, dygraph, vals) {
7a1f1877 209 var chosen = Dygraph.pickDateTickGranularity(a, b, pixels, opts);
48e614ac
DV
210
211 if (chosen >= 0) {
212 return Dygraph.getDateAxis(a, b, chosen, opts, dygraph);
213 } else {
214 // this can happen if self.width_ is zero.
215 return [];
216 }
217};
218
219// Time granularity enumeration
b2867ee1 220// TODO(danvk): make this an @enum
48e614ac
DV
221Dygraph.SECONDLY = 0;
222Dygraph.TWO_SECONDLY = 1;
223Dygraph.FIVE_SECONDLY = 2;
224Dygraph.TEN_SECONDLY = 3;
225Dygraph.THIRTY_SECONDLY = 4;
226Dygraph.MINUTELY = 5;
227Dygraph.TWO_MINUTELY = 6;
228Dygraph.FIVE_MINUTELY = 7;
229Dygraph.TEN_MINUTELY = 8;
230Dygraph.THIRTY_MINUTELY = 9;
231Dygraph.HOURLY = 10;
232Dygraph.TWO_HOURLY = 11;
233Dygraph.SIX_HOURLY = 12;
234Dygraph.DAILY = 13;
235Dygraph.WEEKLY = 14;
236Dygraph.MONTHLY = 15;
237Dygraph.QUARTERLY = 16;
238Dygraph.BIANNUAL = 17;
239Dygraph.ANNUAL = 18;
240Dygraph.DECADAL = 19;
241Dygraph.CENTENNIAL = 20;
242Dygraph.NUM_GRANULARITIES = 21;
243
b2867ee1 244/** @type {Array.<number>} */
48e614ac
DV
245Dygraph.SHORT_SPACINGS = [];
246Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
247Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2;
248Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5;
249Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
250Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
251Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
252Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2;
253Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5;
254Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
255Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
256Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
257Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2;
258Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6;
259Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
260Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
261
2f5f8198
DS
262/**
263 * A collection of objects specifying where it is acceptable to place tick
264 * marks for granularities larger than WEEKLY.
265 * 'months' is an array of month indexes on which to place tick marks.
266 * 'year_mod' ticks are placed when year % year_mod = 0.
267 * @type {Array.<Object>}
268 */
3c1b72e1
DS
269Dygraph.LONG_TICK_PLACEMENTS = [];
270Dygraph.LONG_TICK_PLACEMENTS[Dygraph.MONTHLY] = {
271 months : [0,1,2,3,4,5,6,7,8,9,10,11],
272 year_mod : 1
273};
274Dygraph.LONG_TICK_PLACEMENTS[Dygraph.QUARTERLY] = {
275 months: [0,3,6,9],
276 year_mod: 1
277};
278Dygraph.LONG_TICK_PLACEMENTS[Dygraph.BIANNUAL] = {
279 months: [0,6],
280 year_mod: 1
281};
282Dygraph.LONG_TICK_PLACEMENTS[Dygraph.ANNUAL] = {
283 months: [0],
284 year_mod: 1
285};
286Dygraph.LONG_TICK_PLACEMENTS[Dygraph.DECADAL] = {
287 months: [0],
288 year_mod: 10
289};
290Dygraph.LONG_TICK_PLACEMENTS[Dygraph.CENTENNIAL] = {
291 months: [0],
292 year_mod: 100
293};
294
48e614ac 295/**
48e614ac
DV
296 * This is a list of human-friendly values at which to show tick marks on a log
297 * scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
298 * ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
299 * NOTE: this assumes that Dygraph.LOG_SCALE = 10.
b2867ee1 300 * @type {Array.<number>}
48e614ac
DV
301 */
302Dygraph.PREFERRED_LOG_TICK_VALUES = function() {
303 var vals = [];
304 for (var power = -39; power <= 39; power++) {
305 var range = Math.pow(10, power);
306 for (var mult = 1; mult <= 9; mult++) {
307 var val = range * mult;
308 vals.push(val);
309 }
310 }
311 return vals;
312}();
313
7a1f1877
AV
314/**
315 * Determine the correct granularity of ticks on a date axis.
316 *
b2867ee1
DV
317 * @param {number} a Left edge of the chart (ms)
318 * @param {number} b Right edge of the chart (ms)
319 * @param {number} pixels Size of the chart in the relevant dimension (width).
320 * @param {function(string):*} opts Function mapping from option name ->
321 * value.
322 * @return {number} The appropriate axis granularity for this chart. See the
323 * enumeration of possible values in dygraph-tickers.js.
7a1f1877
AV
324 */
325Dygraph.pickDateTickGranularity = function(a, b, pixels, opts) {
b2867ee1 326 var pixels_per_tick = /** @type{number} */(opts('pixelsPerLabel'));
7a1f1877
AV
327 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
328 var num_ticks = Dygraph.numDateTicks(a, b, i);
329 if (pixels / num_ticks >= pixels_per_tick) {
330 return i;
331 }
332 }
333 return -1;
334};
335
b2867ee1
DV
336/**
337 * @param {number} start_time
338 * @param {number} end_time
339 * @param {number} granularity (one of the granularities enumerated above)
340 * @return {number} Number of ticks that would result.
341 */
48e614ac
DV
342Dygraph.numDateTicks = function(start_time, end_time, granularity) {
343 if (granularity < Dygraph.MONTHLY) {
344 // Generate one tick mark for every fixed interval of time.
345 var spacing = Dygraph.SHORT_SPACINGS[granularity];
346 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
347 } else {
3c1b72e1 348 var tickPlacement = Dygraph.LONG_TICK_PLACEMENTS[granularity];
48e614ac
DV
349
350 var msInYear = 365.2524 * 24 * 3600 * 1000;
351 var num_years = 1.0 * (end_time - start_time) / msInYear;
3c1b72e1 352 return Math.floor(0.5 + 1.0 * num_years * tickPlacement.months.length / tickPlacement.year_mod);
48e614ac
DV
353 }
354};
355
b2867ee1
DV
356/**
357 * @param {number} start_time
358 * @param {number} end_time
359 * @param {number} granularity (one of the granularities enumerated above)
360 * @param {function(string):*} opts Function mapping from option name -&gt; value.
361 * @param {Dygraph=} dg
362 * @return {!Dygraph.TickList}
363 */
48e614ac 364Dygraph.getDateAxis = function(start_time, end_time, granularity, opts, dg) {
d67a4279 365 var formatter = /** @type{AxisLabelFormatter} */(
b2867ee1 366 opts("axisLabelFormatter"));
48e614ac 367 var ticks = [];
758a629f
DV
368 var t;
369
48e614ac
DV
370 if (granularity < Dygraph.MONTHLY) {
371 // Generate one tick mark for every fixed interval of time.
372 var spacing = Dygraph.SHORT_SPACINGS[granularity];
48e614ac
DV
373
374 // Find a time less than start_time which occurs on a "nice" time boundary
375 // for this granularity.
376 var g = spacing / 1000;
01f2337b 377 var d = new Date(start_time);
9a4fd029 378 Dygraph.setDateSameTZ(d, {ms: 0});
0f9bf369 379
758a629f 380 var x;
48e614ac 381 if (g <= 60) { // seconds
0f9bf369 382 x = d.getSeconds();
9a4fd029 383 Dygraph.setDateSameTZ(d, {s: x - x % g});
48e614ac 384 } else {
9a4fd029 385 Dygraph.setDateSameTZ(d, {s: 0});
48e614ac
DV
386 g /= 60;
387 if (g <= 60) { // minutes
0f9bf369 388 x = d.getMinutes();
9a4fd029 389 Dygraph.setDateSameTZ(d, {m: x - x % g});
48e614ac 390 } else {
9a4fd029 391 Dygraph.setDateSameTZ(d, {m: 0});
48e614ac
DV
392 g /= 60;
393
394 if (g <= 24) { // days
0f9bf369
DV
395 x = d.getHours();
396 d.setHours(x - x % g);
48e614ac
DV
397 } else {
398 d.setHours(0);
399 g /= 24;
400
401 if (g == 7) { // one week
402 d.setDate(d.getDate() - d.getDay());
403 }
404 }
405 }
406 }
407 start_time = d.getTime();
408
9a4fd029
DV
409 // For spacings coarser than two-hourly, we want to ignore daylight
410 // savings transitions to get consistent ticks. For finer-grained ticks,
411 // it's essential to show the DST transition in all its messiness.
c6975231 412 var start_offset_min = new Date(start_time).getTimezoneOffset();
0f9bf369
DV
413 var check_dst = (spacing >= Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY]);
414
758a629f 415 for (t = start_time; t <= end_time; t += spacing) {
c180fde5 416 d = new Date(t);
c6975231
DV
417
418 // This ensures that we stay on the same hourly "rhythm" across
419 // daylight savings transitions. Without this, the ticks could get off
420 // by an hour. See tests/daylight-savings.html or issue 147.
0f9bf369 421 if (check_dst && d.getTimezoneOffset() != start_offset_min) {
fb0c64b0
DV
422 var delta_min = d.getTimezoneOffset() - start_offset_min;
423 t += delta_min * 60 * 1000;
c6975231
DV
424 d = new Date(t);
425 start_offset_min = d.getTimezoneOffset();
fb0c64b0
DV
426
427 // Check whether we've backed into the previous timezone again.
428 // This can happen during a "spring forward" transition. In this case,
429 // it's best to skip this tick altogether (we may be shooting for a
430 // non-existent time like the 2AM that's skipped) and go to the next
431 // one.
432 if (new Date(t + spacing).getTimezoneOffset() != start_offset_min) {
433 t += spacing;
434 d = new Date(t);
435 start_offset_min = d.getTimezoneOffset();
436 }
c6975231
DV
437 }
438
48e614ac 439 ticks.push({ v:t,
c6975231 440 label: formatter(d, granularity, opts, dg)
48e614ac
DV
441 });
442 }
443 } else {
444 // Display a tick mark on the first of a set of months of each year.
445 // Years get a tick mark iff y % year_mod == 0. This is useful for
446 // displaying a tick mark once every 10 years, say, on long time scales.
447 var months;
448 var year_mod = 1; // e.g. to only print one point every 10 years.
449
3c1b72e1
DS
450 if (granularity < Dygraph.NUM_GRANULARITIES) {
451 months = Dygraph.LONG_TICK_PLACEMENTS[granularity].months;
452 year_mod = Dygraph.LONG_TICK_PLACEMENTS[granularity].year_mod;
48e614ac
DV
453 } else {
454 Dygraph.warn("Span of dates is too long");
455 }
456
457 var start_year = new Date(start_time).getFullYear();
458 var end_year = new Date(end_time).getFullYear();
459 var zeropad = Dygraph.zeropad;
460 for (var i = start_year; i <= end_year; i++) {
758a629f 461 if (i % year_mod !== 0) continue;
48e614ac
DV
462 for (var j = 0; j < months.length; j++) {
463 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
758a629f 464 t = Dygraph.dateStrToMillis(date_str);
48e614ac
DV
465 if (t < start_time || t > end_time) continue;
466 ticks.push({ v:t,
467 label: formatter(new Date(t), granularity, opts, dg)
468 });
469 }
470 }
471 }
472
473 return ticks;
474};
475
4ec7b44a
MF
476// These are set here so that this file can be included after dygraph.js
477// or independently.
4294a33f
MF
478if (Dygraph &&
479 Dygraph.DEFAULT_ATTRS &&
480 Dygraph.DEFAULT_ATTRS['axes'] &&
481 Dygraph.DEFAULT_ATTRS['axes']['x'] &&
482 Dygraph.DEFAULT_ATTRS['axes']['y'] &&
483 Dygraph.DEFAULT_ATTRS['axes']['y2']) {
484 Dygraph.DEFAULT_ATTRS['axes']['x']['ticker'] = Dygraph.dateTicker;
485 Dygraph.DEFAULT_ATTRS['axes']['y']['ticker'] = Dygraph.numericTicks;
486 Dygraph.DEFAULT_ATTRS['axes']['y2']['ticker'] = Dygraph.numericTicks;
487}