3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Description of this file.
9 * @author danvk@google.com (Dan Vanderkam)
11 * A ticker is a function with the following interface:
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] },
19 * The returned value is called a "tick list".
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
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.
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.
37 * dygraph is the Dygraph object for which an axis is being constructed.
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.
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).
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
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.
61 Dygraph
.numericTicks
= function(a
, b
, pixels
, opts
, dygraph
, vals
) {
62 var pixels_per_tick
= opts('pixelsPerLabel');
65 for (var i
= 0; i
< vals
.length
; i
++) {
66 ticks
.push({v
: vals
[i
]});
69 // TODO(danvk): factor this log-scale block out into a separate function.
70 if (opts("logscale")) {
71 var nTicks
= Math
.floor(pixels
/ pixels_per_tick
);
72 var minIdx
= Dygraph
.binarySearch(a
, Dygraph
.PREFERRED_LOG_TICK_VALUES
, 1);
73 var maxIdx
= Dygraph
.binarySearch(b
, Dygraph
.PREFERRED_LOG_TICK_VALUES
, -1);
78 maxIdx
= Dygraph
.PREFERRED_LOG_TICK_VALUES
.length
- 1;
80 // Count the number of tick values would appear, if we can get at least
81 // nTicks / 4 accept them
.
82 var lastDisplayed
= null;
83 if (maxIdx
- minIdx
>= nTicks
/ 4) {
84 for (var idx
= maxIdx
; idx
>= minIdx
; idx
--) {
85 var tickValue
= Dygraph
.PREFERRED_LOG_TICK_VALUES
[idx
];
86 var pixel_coord
= Math
.log(tickValue
/ a) / Math
.log(b
/ a
) * pixels
;
87 var tick
= { v
: tickValue
};
88 if (lastDisplayed
== null) {
90 tickValue
: tickValue
,
91 pixel_coord
: pixel_coord
94 if (Math
.abs(pixel_coord
- lastDisplayed
.pixel_coord
) >= pixels_per_tick
) {
96 tickValue
: tickValue
,
97 pixel_coord
: pixel_coord
105 // Since we went in backwards order.
110 // ticks.length won't be 0 if the log scale function finds values to insert.
111 if (ticks
.length
== 0) {
113 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
114 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks
).
115 // The first spacing greater than pixelsPerYLabel is what we use.
116 // TODO(danvk): version that works on a log scale.
117 var kmg2
= opts("labelsKMG2");
119 var mults
= [1, 2, 4, 8];
121 var mults
= [1, 2, 5];
123 var scale
, low_val
, high_val
, nTicks
;
124 for (var i
= -10; i
< 50; i
++) {
126 var base_scale
= Math
.pow(16, i
);
128 var base_scale
= Math
.pow(10, i
);
130 for (var j
= 0; j
< mults
.length
; j
++) {
131 scale
= base_scale
* mults
[j
];
132 low_val
= Math
.floor(a
/ scale
) * scale
;
133 high_val
= Math
.ceil(b
/ scale
) * scale
;
134 nTicks
= Math
.abs(high_val
- low_val
) / scale
;
135 var spacing
= pixels
/ nTicks
;
136 // wish I could break out of both loops at once...
137 if (spacing
> pixels_per_tick
) break;
139 if (spacing
> pixels_per_tick
) break;
142 // Construct the set of ticks.
143 // Allow reverse y-axis if it's explicitly requested.
144 if (low_val
> high_val
) scale
*= -1;
145 for (var i
= 0; i
< nTicks
; i
++) {
146 var tickV
= low_val
+ i
* scale
;
147 ticks
.push( {v
: tickV
} );
152 // Add formatted labels to the ticks.
155 if (opts("labelsKMB")) {
157 k_labels
= [ "K", "M", "B", "T" ];
159 if (opts("labelsKMG2")) {
160 if (k
) self
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
162 k_labels
= [ "k", "M", "G", "T" ];
165 var formatter
= opts('axisLabelFormatter');
167 // Add labels to the ticks.
168 for (var i
= 0; i
< ticks
.length
; i
++) {
169 if (ticks
[i
].label
!== undefined
) continue; // Use current label.
170 var tickV
= ticks
[i
].v
;
171 var absTickV
= Math
.abs(tickV
);
172 // TODO(danvk): set granularity to something appropriate here.
173 var label
= formatter(tickV
, 0, opts
, dygraph
);
174 if (k_labels
.length
> 0) {
175 // TODO(danvk): should this be integrated into the axisLabelFormatter?
176 // Round up to an appropriate unit.
178 for (var j
= 3; j
>= 0; j
--, n
/= k
) {
180 label
= Dygraph
.round_(tickV
/ n
, opts('digitsAfterDecimal')) +
186 ticks
[i
].label
= label
;
193 Dygraph
.dateTicker
= function(a
, b
, pixels
, opts
, dygraph
, vals
) {
194 var pixels_per_tick
= opts('pixelsPerLabel');
196 for (var i
= 0; i
< Dygraph
.NUM_GRANULARITIES
; i
++) {
197 var num_ticks
= Dygraph
.numDateTicks(a
, b
, i
);
198 if (pixels
/ num_ticks
>= pixels_per_tick
) {
205 return Dygraph
.getDateAxis(a
, b
, chosen
, opts
, dygraph
);
207 // this can happen if self.width_ is zero.
212 // Time granularity enumeration
213 Dygraph
.SECONDLY
= 0;
214 Dygraph
.TWO_SECONDLY
= 1;
215 Dygraph
.FIVE_SECONDLY
= 2;
216 Dygraph
.TEN_SECONDLY
= 3;
217 Dygraph
.THIRTY_SECONDLY
= 4;
218 Dygraph
.MINUTELY
= 5;
219 Dygraph
.TWO_MINUTELY
= 6;
220 Dygraph
.FIVE_MINUTELY
= 7;
221 Dygraph
.TEN_MINUTELY
= 8;
222 Dygraph
.THIRTY_MINUTELY
= 9;
224 Dygraph
.TWO_HOURLY
= 11;
225 Dygraph
.SIX_HOURLY
= 12;
228 Dygraph
.MONTHLY
= 15;
229 Dygraph
.QUARTERLY
= 16;
230 Dygraph
.BIANNUAL
= 17;
232 Dygraph
.DECADAL
= 19;
233 Dygraph
.CENTENNIAL
= 20;
234 Dygraph
.NUM_GRANULARITIES
= 21;
236 Dygraph
.SHORT_SPACINGS
= [];
237 Dygraph
.SHORT_SPACINGS
[Dygraph
.SECONDLY
] = 1000 * 1;
238 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_SECONDLY
] = 1000 * 2;
239 Dygraph
.SHORT_SPACINGS
[Dygraph
.FIVE_SECONDLY
] = 1000 * 5;
240 Dygraph
.SHORT_SPACINGS
[Dygraph
.TEN_SECONDLY
] = 1000 * 10;
241 Dygraph
.SHORT_SPACINGS
[Dygraph
.THIRTY_SECONDLY
] = 1000 * 30;
242 Dygraph
.SHORT_SPACINGS
[Dygraph
.MINUTELY
] = 1000 * 60;
243 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_MINUTELY
] = 1000 * 60 * 2;
244 Dygraph
.SHORT_SPACINGS
[Dygraph
.FIVE_MINUTELY
] = 1000 * 60 * 5;
245 Dygraph
.SHORT_SPACINGS
[Dygraph
.TEN_MINUTELY
] = 1000 * 60 * 10;
246 Dygraph
.SHORT_SPACINGS
[Dygraph
.THIRTY_MINUTELY
] = 1000 * 60 * 30;
247 Dygraph
.SHORT_SPACINGS
[Dygraph
.HOURLY
] = 1000 * 3600;
248 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_HOURLY
] = 1000 * 3600 * 2;
249 Dygraph
.SHORT_SPACINGS
[Dygraph
.SIX_HOURLY
] = 1000 * 3600 * 6;
250 Dygraph
.SHORT_SPACINGS
[Dygraph
.DAILY
] = 1000 * 86400;
251 Dygraph
.SHORT_SPACINGS
[Dygraph
.WEEKLY
] = 1000 * 604800;
255 * This is a list of human-friendly values at which to show tick marks on a log
256 * scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
257 * ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
258 * NOTE: this assumes that Dygraph.LOG_SCALE = 10.
260 Dygraph
.PREFERRED_LOG_TICK_VALUES
= function() {
262 for (var power
= -39; power
<= 39; power
++) {
263 var range
= Math
.pow(10, power
);
264 for (var mult
= 1; mult
<= 9; mult
++) {
265 var val
= range
* mult
;
272 Dygraph
.numDateTicks
= function(start_time
, end_time
, granularity
) {
273 if (granularity
< Dygraph
.MONTHLY
) {
274 // Generate one tick mark for every fixed interval of time.
275 var spacing
= Dygraph
.SHORT_SPACINGS
[granularity
];
276 return Math
.floor(0.5 + 1.0 * (end_time
- start_time
) / spacing
);
278 var year_mod
= 1; // e.g. to only print one point every 10 years.
280 if (granularity
== Dygraph
.QUARTERLY
) num_months
= 3;
281 if (granularity
== Dygraph
.BIANNUAL
) num_months
= 2;
282 if (granularity
== Dygraph
.ANNUAL
) num_months
= 1;
283 if (granularity
== Dygraph
.DECADAL
) { num_months
= 1; year_mod
= 10; }
284 if (granularity
== Dygraph
.CENTENNIAL
) { num_months
= 1; year_mod
= 100; }
286 var msInYear
= 365.2524 * 24 * 3600 * 1000;
287 var num_years
= 1.0 * (end_time
- start_time
) / msInYear
;
288 return Math
.floor(0.5 + 1.0 * num_years
* num_months
/ year_mod
);
292 Dygraph
.getDateAxis
= function(start_time
, end_time
, granularity
, opts
, dg
) {
293 var formatter
= opts("axisLabelFormatter");
295 if (granularity
< Dygraph
.MONTHLY
) {
296 // Generate one tick mark for every fixed interval of time.
297 var spacing
= Dygraph
.SHORT_SPACINGS
[granularity
];
298 var format
= '%d%b'; // e.g. "1Jan"
300 // Find a time less than start_time which occurs on a "nice" time boundary
301 // for this granularity.
302 var g
= spacing
/ 1000;
303 var d
= new Date(start_time
);
304 if (g
<= 60) { // seconds
305 var x
= d
.getSeconds(); d
.setSeconds(x
- x
% g
);
309 if (g
<= 60) { // minutes
310 var x
= d
.getMinutes(); d
.setMinutes(x
- x
% g
);
315 if (g
<= 24) { // days
316 var x
= d
.getHours(); d
.setHours(x
- x
% g
);
321 if (g
== 7) { // one week
322 d
.setDate(d
.getDate() - d
.getDay());
327 start_time
= d
.getTime();
329 for (var t
= start_time
; t
<= end_time
; t
+= spacing
) {
331 label
: formatter(new Date(t
), granularity
, opts
, dg
)
335 // Display a tick mark on the first of a set of months of each year.
336 // Years get a tick mark iff y % year_mod == 0. This is useful for
337 // displaying a tick mark once every 10 years, say, on long time scales.
339 var year_mod
= 1; // e.g. to only print one point every 10 years.
341 if (granularity
== Dygraph
.MONTHLY
) {
342 months
= [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ];
343 } else if (granularity
== Dygraph
.QUARTERLY
) {
344 months
= [ 0, 3, 6, 9 ];
345 } else if (granularity
== Dygraph
.BIANNUAL
) {
347 } else if (granularity
== Dygraph
.ANNUAL
) {
349 } else if (granularity
== Dygraph
.DECADAL
) {
352 } else if (granularity
== Dygraph
.CENTENNIAL
) {
356 Dygraph
.warn("Span of dates is too long");
359 var start_year
= new Date(start_time
).getFullYear();
360 var end_year
= new Date(end_time
).getFullYear();
361 var zeropad
= Dygraph
.zeropad
;
362 for (var i
= start_year
; i
<= end_year
; i
++) {
363 if (i
% year_mod
!= 0) continue;
364 for (var j
= 0; j
< months
.length
; j
++) {
365 var date_str
= i
+ "/" + zeropad(1 + months[j]) + "/01";
366 var t
= Dygraph
.dateStrToMillis(date_str
);
367 if (t
< start_time
|| t
> end_time
) continue;
369 label
: formatter(new Date(t
), granularity
, opts
, dg
)
378 // These are set here so that this file can be included after dygraph.js.
379 Dygraph
.DEFAULT_ATTRS
.axes
.x
.ticker
= Dygraph
.dateTicker
;
380 Dygraph
.DEFAULT_ATTRS
.axes
.y
.ticker
= Dygraph
.numericTicks
;
381 Dygraph
.DEFAULT_ATTRS
.axes
.y2
.ticker
= Dygraph
.numericTicks
;