Merge pull request #573 from danvk/coverage-cleanup
[dygraphs.git] / src / plugins / range-selector.js
CommitLineData
0d216a60 1/**
41da6a86 2 * @license
ec475f44 3 * Copyright 2011 Paul Felix (paul.eric.felix@gmail.com)
41da6a86
DV
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
0cd1ad15 6/*global Dygraph:false,TouchEvent:false */
ccd9d7c2
PF
7
8/**
0d216a60 9 * @fileoverview This file contains the RangeSelector plugin used to provide
ccd9d7c2
PF
10 * a timeline range selector widget for dygraphs.
11 */
12
0d216a60
PF
13Dygraph.Plugins.RangeSelector = (function() {
14
758a629f 15/*global Dygraph:false */
c0f54d4f
DV
16"use strict";
17
0d216a60 18var rangeSelector = function() {
73c5deff 19 this.hasTouchInterface_ = typeof(TouchEvent) != 'undefined';
0c76da8d 20 this.isMobileDevice_ = /mobile|android/gi.test(navigator.appVersion);
84074adc 21 this.interfaceCreated_ = false;
0d216a60
PF
22};
23
24rangeSelector.prototype.toString = function() {
25 return "RangeSelector Plugin";
26};
27
28rangeSelector.prototype.activate = function(dygraph) {
29 this.dygraph_ = dygraph;
ec475f44 30 if (this.getOption_('showRangeSelector')) {
0d216a60
PF
31 this.createInterface_();
32 }
33 return {
34 layout: this.reserveSpace_,
35 predraw: this.renderStaticLayer_,
36 didDrawChart: this.renderInteractiveLayer_
37 };
38};
39
40rangeSelector.prototype.destroy = function() {
41 this.bgcanvas_ = null;
42 this.fgcanvas_ = null;
43 this.leftZoomHandle_ = null;
44 this.rightZoomHandle_ = null;
0d216a60
PF
45};
46
47//------------------------------------------------------------------
48// Private methods
49//------------------------------------------------------------------
50
0a0885d1
DV
51rangeSelector.prototype.getOption_ = function(name, opt_series) {
52 return this.dygraph_.getOption(name, opt_series);
ec475f44
PF
53};
54
55rangeSelector.prototype.setDefaultOption_ = function(name, value) {
46fd9089 56 this.dygraph_.attrs_[name] = value;
0d216a60
PF
57};
58
59/**
60 * @private
61 * Creates the range selector elements and adds them to the graph.
62 */
63rangeSelector.prototype.createInterface_ = function() {
ccd9d7c2
PF
64 this.createCanvases_();
65 this.createZoomHandles_();
66 this.initInteraction_();
0d216a60
PF
67
68 // Range selector and animatedZooms have a bad interaction. See issue 359.
ec475f44 69 if (this.getOption_('animatedZooms')) {
8a68db7d 70 console.warn('Animated zooms and range selector are not compatible; disabling animatedZooms.');
ec475f44 71 this.dygraph_.updateOptions({animatedZooms: false}, true);
0d216a60
PF
72 }
73
84074adc 74 this.interfaceCreated_ = true;
0d216a60 75 this.addToGraph_();
ccd9d7c2
PF
76};
77
78/**
0d216a60
PF
79 * @private
80 * Adds the range selector to the graph.
ccd9d7c2 81 */
0d216a60 82rangeSelector.prototype.addToGraph_ = function() {
84074adc 83 var graphDiv = this.graphDiv_ = this.dygraph_.graphDiv;
ccd9d7c2
PF
84 graphDiv.appendChild(this.bgcanvas_);
85 graphDiv.appendChild(this.fgcanvas_);
86 graphDiv.appendChild(this.leftZoomHandle_);
87 graphDiv.appendChild(this.rightZoomHandle_);
0d216a60
PF
88};
89
90/**
91 * @private
92 * Removes the range selector from the graph.
93 */
94rangeSelector.prototype.removeFromGraph_ = function() {
ec475f44 95 var graphDiv = this.graphDiv_;
0d216a60
PF
96 graphDiv.removeChild(this.bgcanvas_);
97 graphDiv.removeChild(this.fgcanvas_);
98 graphDiv.removeChild(this.leftZoomHandle_);
99 graphDiv.removeChild(this.rightZoomHandle_);
84074adc 100 this.graphDiv_ = null;
0d216a60
PF
101};
102
103/**
104 * @private
105 * Called by Layout to allow range selector to reserve its space.
106 */
107rangeSelector.prototype.reserveSpace_ = function(e) {
ec475f44
PF
108 if (this.getOption_('showRangeSelector')) {
109 e.reserveSpaceBottom(this.getOption_('rangeSelectorHeight') + 4);
0d216a60 110 }
ccd9d7c2
PF
111};
112
113/**
0d216a60
PF
114 * @private
115 * Renders the static portion of the range selector at the predraw stage.
ccd9d7c2 116 */
0d216a60 117rangeSelector.prototype.renderStaticLayer_ = function() {
84074adc 118 if (!this.updateVisibility_()) {
0d216a60
PF
119 return;
120 }
ccd9d7c2
PF
121 this.resize_();
122 this.drawStaticLayer_();
123};
124
125/**
0d216a60
PF
126 * @private
127 * Renders the interactive portion of the range selector after the chart has been drawn.
ccd9d7c2 128 */
0d216a60 129rangeSelector.prototype.renderInteractiveLayer_ = function() {
84074adc 130 if (!this.updateVisibility_() || this.isChangingRange_) {
ccd9d7c2
PF
131 return;
132 }
ccd9d7c2
PF
133 this.placeZoomHandles_();
134 this.drawInteractiveLayer_();
135};
136
137/**
138 * @private
84074adc 139 * Check to see if the range selector is enabled/disabled and update visibility accordingly.
0d216a60 140 */
84074adc 141rangeSelector.prototype.updateVisibility_ = function() {
ec475f44 142 var enabled = this.getOption_('showRangeSelector');
0d216a60 143 if (enabled) {
84074adc 144 if (!this.interfaceCreated_) {
0d216a60 145 this.createInterface_();
84074adc 146 } else if (!this.graphDiv_ || !this.graphDiv_.parentNode) {
0d216a60
PF
147 this.addToGraph_();
148 }
84074adc 149 } else if (this.graphDiv_) {
0d216a60
PF
150 this.removeFromGraph_();
151 var dygraph = this.dygraph_;
152 setTimeout(function() { dygraph.width_ = 0; dygraph.resize(); }, 1);
153 }
154 return enabled;
83b0c192 155};
0d216a60
PF
156
157/**
158 * @private
ccd9d7c2
PF
159 * Resizes the range selector.
160 */
0d216a60 161rangeSelector.prototype.resize_ = function() {
3a0e53a4
AK
162 function setElementRect(canvas, context, rect) {
163 var canvasScale = Dygraph.getContextPixelRatio(context);
164
ccd9d7c2
PF
165 canvas.style.top = rect.y + 'px';
166 canvas.style.left = rect.x + 'px';
3a0e53a4
AK
167 canvas.width = rect.w * canvasScale;
168 canvas.height = rect.h * canvasScale;
169 canvas.style.width = rect.w + 'px';
170 canvas.style.height = rect.h + 'px';
171
172 if(canvasScale != 1) {
173 context.scale(canvasScale, canvasScale);
174 }
758a629f 175 }
ccd9d7c2 176
84074adc 177 var plotArea = this.dygraph_.layout_.getPlotArea();
b77d7a56 178
003a590a 179 var xAxisLabelHeight = 0;
464b5f50 180 if (this.dygraph_.getOptionForAxis('drawAxis', 'x')) {
003a590a 181 xAxisLabelHeight = this.getOption_('xAxisHeight') || (this.getOption_('axisLabelFontSize') + 2 * this.getOption_('axisTickSize'));
182 }
ccd9d7c2
PF
183 this.canvasRect_ = {
184 x: plotArea.x,
185 y: plotArea.y + plotArea.h + xAxisLabelHeight + 4,
186 w: plotArea.w,
ec475f44 187 h: this.getOption_('rangeSelectorHeight')
ccd9d7c2
PF
188 };
189
3a0e53a4
AK
190 setElementRect(this.bgcanvas_, this.bgcanvas_ctx_, this.canvasRect_);
191 setElementRect(this.fgcanvas_, this.fgcanvas_ctx_, this.canvasRect_);
ccd9d7c2
PF
192};
193
ccd9d7c2
PF
194/**
195 * @private
196 * Creates the background and foreground canvases.
197 */
0d216a60 198rangeSelector.prototype.createCanvases_ = function() {
ccd9d7c2 199 this.bgcanvas_ = Dygraph.createCanvas();
88c4a47e 200 this.bgcanvas_.className = 'dygraph-rangesel-bgcanvas';
ccd9d7c2 201 this.bgcanvas_.style.position = 'absolute';
920208fb 202 this.bgcanvas_.style.zIndex = 9;
ccd9d7c2
PF
203 this.bgcanvas_ctx_ = Dygraph.getContext(this.bgcanvas_);
204
205 this.fgcanvas_ = Dygraph.createCanvas();
88c4a47e 206 this.fgcanvas_.className = 'dygraph-rangesel-fgcanvas';
ccd9d7c2 207 this.fgcanvas_.style.position = 'absolute';
920208fb 208 this.fgcanvas_.style.zIndex = 9;
ccd9d7c2
PF
209 this.fgcanvas_.style.cursor = 'default';
210 this.fgcanvas_ctx_ = Dygraph.getContext(this.fgcanvas_);
211};
212
213/**
214 * @private
215 * Creates the zoom handle elements.
216 */
0d216a60 217rangeSelector.prototype.createZoomHandles_ = function() {
ccd9d7c2 218 var img = new Image();
88c4a47e 219 img.className = 'dygraph-rangesel-zoomhandle';
ccd9d7c2 220 img.style.position = 'absolute';
920208fb 221 img.style.zIndex = 10;
ccd9d7c2
PF
222 img.style.visibility = 'hidden'; // Initially hidden so they don't show up in the wrong place.
223 img.style.cursor = 'col-resize';
920e93f2
DV
224 // TODO: change image to more options
225 img.width = 9;
226 img.height = 16;
227 img.src = 'data:image/png;base64,' +
758a629f
DV
228'iVBORw0KGgoAAAANSUhEUgAAAAkAAAAQCAYAAADESFVDAAAAAXNSR0IArs4c6QAAAAZiS0dEANAA' +
229'zwDP4Z7KegAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAAd0SU1FB9sHGw0cMqdt1UwAAAAZdEVYdENv' +
230'bW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAAaElEQVQoz+3SsRFAQBCF4Z9WJM8KCDVwownl' +
231'6YXsTmCUsyKGkZzcl7zkz3YLkypgAnreFmDEpHkIwVOMfpdi9CEEN2nGpFdwD03yEqDtOgCaun7s' +
232'qSTDH32I1pQA2Pb9sZecAxc5r3IAb21d6878xsAAAAAASUVORK5CYII=';
ccd9d7c2 233
0c76da8d 234 if (this.isMobileDevice_) {
73c5deff
PF
235 img.width *= 2;
236 img.height *= 2;
237 }
238
ccd9d7c2
PF
239 this.leftZoomHandle_ = img;
240 this.rightZoomHandle_ = img.cloneNode(false);
241};
242
243/**
244 * @private
245 * Sets up the interaction for the range selector.
246 */
0d216a60 247rangeSelector.prototype.initInteraction_ = function() {
ccd9d7c2 248 var self = this;
bcf7f810 249 var topElem = document;
2871344a 250 var clientXLast = 0;
ccd9d7c2
PF
251 var handle = null;
252 var isZooming = false;
253 var isPanning = false;
9901b0c1 254 var dynamic = !this.isMobileDevice_;
ccd9d7c2 255
2bad4d92
DV
256 // We cover iframes during mouse interactions. See comments in
257 // dygraph-utils.js for more info on why this is a good idea.
258 var tarp = new Dygraph.IFrameTarp();
259
758a629f
DV
260 // functions, defined below. Defining them this way (rather than with
261 // "function foo() {...}" makes JSHint happy.
262 var toXDataWindow, onZoomStart, onZoom, onZoomEnd, doZoom, isMouseInPanZone,
2871344a 263 onPanStart, onPan, onPanEnd, doPan, onCanvasHover;
758a629f 264
73c5deff
PF
265 // Touch event functions
266 var onZoomHandleTouchEvent, onCanvasTouchEvent, addTouchEvents;
267
758a629f 268 toXDataWindow = function(zoomHandleStatus) {
ccd9d7c2
PF
269 var xDataLimits = self.dygraph_.xAxisExtremes();
270 var fact = (xDataLimits[1] - xDataLimits[0])/self.canvasRect_.w;
271 var xDataMin = xDataLimits[0] + (zoomHandleStatus.leftHandlePos - self.canvasRect_.x)*fact;
272 var xDataMax = xDataLimits[0] + (zoomHandleStatus.rightHandlePos - self.canvasRect_.x)*fact;
273 return [xDataMin, xDataMax];
274 };
275
758a629f 276 onZoomStart = function(e) {
ccd9d7c2
PF
277 Dygraph.cancelEvent(e);
278 isZooming = true;
2871344a 279 clientXLast = e.clientX;
ccd9d7c2 280 handle = e.target ? e.target : e.srcElement;
6835cab8 281 if (e.type === 'mousedown' || e.type === 'dragstart') {
4f41df5a 282 // These events are removed manually.
6835cab8
PF
283 Dygraph.addEvent(topElem, 'mousemove', onZoom);
284 Dygraph.addEvent(topElem, 'mouseup', onZoomEnd);
285 }
ccd9d7c2 286 self.fgcanvas_.style.cursor = 'col-resize';
2bad4d92 287 tarp.cover();
0c76da8d 288 return true;
ccd9d7c2
PF
289 };
290
758a629f 291 onZoom = function(e) {
ccd9d7c2 292 if (!isZooming) {
0c76da8d 293 return false;
ccd9d7c2 294 }
0c76da8d 295 Dygraph.cancelEvent(e);
6835cab8 296
2871344a 297 var delX = e.clientX - clientXLast;
6835cab8 298 if (Math.abs(delX) < 4) {
0c76da8d 299 return true;
ccd9d7c2 300 }
2871344a 301 clientXLast = e.clientX;
0c76da8d
PF
302
303 // Move handle.
ccd9d7c2 304 var zoomHandleStatus = self.getZoomHandleStatus_();
758a629f 305 var newPos;
ccd9d7c2 306 if (handle == self.leftZoomHandle_) {
2871344a 307 newPos = zoomHandleStatus.leftHandlePos + delX;
ccd9d7c2
PF
308 newPos = Math.min(newPos, zoomHandleStatus.rightHandlePos - handle.width - 3);
309 newPos = Math.max(newPos, self.canvasRect_.x);
310 } else {
2871344a 311 newPos = zoomHandleStatus.rightHandlePos + delX;
ccd9d7c2
PF
312 newPos = Math.min(newPos, self.canvasRect_.x + self.canvasRect_.w);
313 newPos = Math.max(newPos, zoomHandleStatus.leftHandlePos + handle.width + 3);
314 }
920208fb 315 var halfHandleWidth = handle.width/2;
ccd9d7c2
PF
316 handle.style.left = (newPos - halfHandleWidth) + 'px';
317 self.drawInteractiveLayer_();
318
9901b0c1 319 // Zoom on the fly.
73c5deff 320 if (dynamic) {
ccd9d7c2
PF
321 doZoom();
322 }
0c76da8d 323 return true;
ccd9d7c2
PF
324 };
325
758a629f 326 onZoomEnd = function(e) {
ccd9d7c2 327 if (!isZooming) {
0c76da8d 328 return false;
ccd9d7c2
PF
329 }
330 isZooming = false;
2bad4d92 331 tarp.uncover();
ccd9d7c2
PF
332 Dygraph.removeEvent(topElem, 'mousemove', onZoom);
333 Dygraph.removeEvent(topElem, 'mouseup', onZoomEnd);
334 self.fgcanvas_.style.cursor = 'default';
335
9901b0c1 336 // If on a slower device, zoom now.
73c5deff 337 if (!dynamic) {
ccd9d7c2
PF
338 doZoom();
339 }
0c76da8d 340 return true;
ccd9d7c2
PF
341 };
342
758a629f 343 doZoom = function() {
ccd9d7c2
PF
344 try {
345 var zoomHandleStatus = self.getZoomHandleStatus_();
346 self.isChangingRange_ = true;
347 if (!zoomHandleStatus.isZoomed) {
e4f6e11a 348 self.dygraph_.resetZoom();
ccd9d7c2
PF
349 } else {
350 var xDataWindow = toXDataWindow(zoomHandleStatus);
351 self.dygraph_.doZoomXDates_(xDataWindow[0], xDataWindow[1]);
352 }
353 } finally {
354 self.isChangingRange_ = false;
355 }
356 };
357
758a629f 358 isMouseInPanZone = function(e) {
9901b0c1
DV
359 var rect = self.leftZoomHandle_.getBoundingClientRect();
360 var leftHandleClientX = rect.left + rect.width/2;
361 rect = self.rightZoomHandle_.getBoundingClientRect();
362 var rightHandleClientX = rect.left + rect.width/2;
363 return (e.clientX > leftHandleClientX && e.clientX < rightHandleClientX);
ccd9d7c2
PF
364 };
365
758a629f 366 onPanStart = function(e) {
ccd9d7c2
PF
367 if (!isPanning && isMouseInPanZone(e) && self.getZoomHandleStatus_().isZoomed) {
368 Dygraph.cancelEvent(e);
369 isPanning = true;
2871344a 370 clientXLast = e.clientX;
6835cab8 371 if (e.type === 'mousedown') {
4f41df5a 372 // These events are removed manually.
6835cab8
PF
373 Dygraph.addEvent(topElem, 'mousemove', onPan);
374 Dygraph.addEvent(topElem, 'mouseup', onPanEnd);
375 }
0c76da8d 376 return true;
ccd9d7c2 377 }
0c76da8d 378 return false;
ccd9d7c2
PF
379 };
380
758a629f 381 onPan = function(e) {
ccd9d7c2 382 if (!isPanning) {
0c76da8d 383 return false;
ccd9d7c2 384 }
920208fb 385 Dygraph.cancelEvent(e);
ccd9d7c2 386
2871344a 387 var delX = e.clientX - clientXLast;
ccd9d7c2 388 if (Math.abs(delX) < 4) {
0c76da8d 389 return true;
ccd9d7c2 390 }
2871344a 391 clientXLast = e.clientX;
ccd9d7c2
PF
392
393 // Move range view
394 var zoomHandleStatus = self.getZoomHandleStatus_();
395 var leftHandlePos = zoomHandleStatus.leftHandlePos;
396 var rightHandlePos = zoomHandleStatus.rightHandlePos;
397 var rangeSize = rightHandlePos - leftHandlePos;
398 if (leftHandlePos + delX <= self.canvasRect_.x) {
399 leftHandlePos = self.canvasRect_.x;
400 rightHandlePos = leftHandlePos + rangeSize;
401 } else if (rightHandlePos + delX >= self.canvasRect_.x + self.canvasRect_.w) {
402 rightHandlePos = self.canvasRect_.x + self.canvasRect_.w;
403 leftHandlePos = rightHandlePos - rangeSize;
404 } else {
405 leftHandlePos += delX;
406 rightHandlePos += delX;
407 }
920208fb 408 var halfHandleWidth = self.leftZoomHandle_.width/2;
ccd9d7c2
PF
409 self.leftZoomHandle_.style.left = (leftHandlePos - halfHandleWidth) + 'px';
410 self.rightZoomHandle_.style.left = (rightHandlePos - halfHandleWidth) + 'px';
411 self.drawInteractiveLayer_();
412
9901b0c1 413 // Do pan on the fly.
73c5deff 414 if (dynamic) {
ccd9d7c2
PF
415 doPan();
416 }
0c76da8d 417 return true;
ccd9d7c2
PF
418 };
419
758a629f 420 onPanEnd = function(e) {
ccd9d7c2 421 if (!isPanning) {
0c76da8d 422 return false;
ccd9d7c2
PF
423 }
424 isPanning = false;
425 Dygraph.removeEvent(topElem, 'mousemove', onPan);
426 Dygraph.removeEvent(topElem, 'mouseup', onPanEnd);
9901b0c1 427 // If on a slower device, do pan now.
73c5deff 428 if (!dynamic) {
ccd9d7c2
PF
429 doPan();
430 }
0c76da8d 431 return true;
ccd9d7c2
PF
432 };
433
758a629f 434 doPan = function() {
ccd9d7c2
PF
435 try {
436 self.isChangingRange_ = true;
437 self.dygraph_.dateWindow_ = toXDataWindow(self.getZoomHandleStatus_());
438 self.dygraph_.drawGraph_(false);
439 } finally {
440 self.isChangingRange_ = false;
441 }
442 };
443
6835cab8 444 onCanvasHover = function(e) {
ccd9d7c2
PF
445 if (isZooming || isPanning) {
446 return;
447 }
448 var cursor = isMouseInPanZone(e) ? 'move' : 'default';
449 if (cursor != self.fgcanvas_.style.cursor) {
450 self.fgcanvas_.style.cursor = cursor;
451 }
452 };
453
73c5deff 454 onZoomHandleTouchEvent = function(e) {
0c76da8d
PF
455 if (e.type == 'touchstart' && e.targetTouches.length == 1) {
456 if (onZoomStart(e.targetTouches[0])) {
457 Dygraph.cancelEvent(e);
458 }
459 } else if (e.type == 'touchmove' && e.targetTouches.length == 1) {
460 if (onZoom(e.targetTouches[0])) {
461 Dygraph.cancelEvent(e);
462 }
73c5deff
PF
463 } else {
464 onZoomEnd(e);
465 }
466 };
467
468 onCanvasTouchEvent = function(e) {
0c76da8d
PF
469 if (e.type == 'touchstart' && e.targetTouches.length == 1) {
470 if (onPanStart(e.targetTouches[0])) {
471 Dygraph.cancelEvent(e);
472 }
473 } else if (e.type == 'touchmove' && e.targetTouches.length == 1) {
474 if (onPan(e.targetTouches[0])) {
475 Dygraph.cancelEvent(e);
476 }
73c5deff
PF
477 } else {
478 onPanEnd(e);
479 }
480 };
481
482 addTouchEvents = function(elem, fn) {
6a4587ac
RK
483 var types = ['touchstart', 'touchend', 'touchmove', 'touchcancel'];
484 for (var i = 0; i < types.length; i++) {
aeca29ac 485 self.dygraph_.addAndTrackEvent(elem, types[i], fn);
6a4587ac 486 }
73c5deff
PF
487 };
488
ec475f44
PF
489 this.setDefaultOption_('interactionModel', Dygraph.Interaction.dragIsPanInteractionModel);
490 this.setDefaultOption_('panEdgeFraction', 0.0001);
ccd9d7c2 491
920208fb 492 var dragStartEvent = window.opera ? 'mousedown' : 'dragstart';
aeca29ac
RK
493 this.dygraph_.addAndTrackEvent(this.leftZoomHandle_, dragStartEvent, onZoomStart);
494 this.dygraph_.addAndTrackEvent(this.rightZoomHandle_, dragStartEvent, onZoomStart);
920208fb 495
9901b0c1
DV
496 this.dygraph_.addAndTrackEvent(this.fgcanvas_, 'mousedown', onPanStart);
497 this.dygraph_.addAndTrackEvent(this.fgcanvas_, 'mousemove', onCanvasHover);
73c5deff
PF
498
499 // Touch events
500 if (this.hasTouchInterface_) {
501 addTouchEvents(this.leftZoomHandle_, onZoomHandleTouchEvent);
502 addTouchEvents(this.rightZoomHandle_, onZoomHandleTouchEvent);
503 addTouchEvents(this.fgcanvas_, onCanvasTouchEvent);
504 }
ccd9d7c2
PF
505};
506
507/**
508 * @private
509 * Draws the static layer in the background canvas.
510 */
0d216a60 511rangeSelector.prototype.drawStaticLayer_ = function() {
ccd9d7c2
PF
512 var ctx = this.bgcanvas_ctx_;
513 ctx.clearRect(0, 0, this.canvasRect_.w, this.canvasRect_.h);
db6a9f5a 514 try {
ccd9d7c2 515 this.drawMiniPlot_();
db6a9f5a 516 } catch(ex) {
8a68db7d 517 console.warn(ex);
db6a9f5a 518 }
920208fb 519
758a629f 520 var margin = 0.5;
fb24d32c 521 this.bgcanvas_ctx_.lineWidth = this.getOption_('rangeSelectorBackgroundLineWidth');
522 ctx.strokeStyle = this.getOption_('rangeSelectorBackgroundStrokeColor');
920208fb
PF
523 ctx.beginPath();
524 ctx.moveTo(margin, margin);
525 ctx.lineTo(margin, this.canvasRect_.h-margin);
526 ctx.lineTo(this.canvasRect_.w-margin, this.canvasRect_.h-margin);
527 ctx.lineTo(this.canvasRect_.w-margin, margin);
528 ctx.stroke();
ccd9d7c2
PF
529};
530
531
532/**
533 * @private
534 * Draws the mini plot in the background canvas.
535 */
0d216a60 536rangeSelector.prototype.drawMiniPlot_ = function() {
ec475f44 537 var fillStyle = this.getOption_('rangeSelectorPlotFillColor');
79cb28dd 538 var fillGradientStyle = this.getOption_('rangeSelectorPlotFillGradientColor');
ec475f44 539 var strokeStyle = this.getOption_('rangeSelectorPlotStrokeColor');
ccd9d7c2
PF
540 if (!fillStyle && !strokeStyle) {
541 return;
542 }
543
ec475f44 544 var stepPlot = this.getOption_('stepPlot');
e03d443c 545
ccd9d7c2
PF
546 var combinedSeriesData = this.computeCombinedSeriesAndLimits_();
547 var yRange = combinedSeriesData.yMax - combinedSeriesData.yMin;
548
549 // Draw the mini plot.
550 var ctx = this.bgcanvas_ctx_;
758a629f 551 var margin = 0.5;
ccd9d7c2
PF
552
553 var xExtremes = this.dygraph_.xAxisExtremes();
554 var xRange = Math.max(xExtremes[1] - xExtremes[0], 1.e-30);
555 var xFact = (this.canvasRect_.w - margin)/xRange;
556 var yFact = (this.canvasRect_.h - margin)/yRange;
557 var canvasWidth = this.canvasRect_.w - margin;
558 var canvasHeight = this.canvasRect_.h - margin;
559
e03d443c
WB
560 var prevX = null, prevY = null;
561
ccd9d7c2
PF
562 ctx.beginPath();
563 ctx.moveTo(margin, canvasHeight);
564 for (var i = 0; i < combinedSeriesData.data.length; i++) {
565 var dataPoint = combinedSeriesData.data[i];
e03d443c
WB
566 var x = ((dataPoint[0] !== null) ? ((dataPoint[0] - xExtremes[0])*xFact) : NaN);
567 var y = ((dataPoint[1] !== null) ? (canvasHeight - (dataPoint[1] - combinedSeriesData.yMin)*yFact) : NaN);
5575fa36
DV
568
569 // Skip points that don't change the x-value. Overly fine-grained points
570 // can cause major slowdowns with the ctx.fill() call below.
69c9b9f2 571 if (!stepPlot && prevX !== null && Math.round(x) == Math.round(prevX)) {
5575fa36
DV
572 continue;
573 }
574
ccd9d7c2 575 if (isFinite(x) && isFinite(y)) {
e03d443c 576 if(prevX === null) {
87196f1b
WB
577 ctx.lineTo(x, canvasHeight);
578 }
579 else if (stepPlot) {
580 ctx.lineTo(x, prevY);
581 }
ccd9d7c2 582 ctx.lineTo(x, y);
e03d443c 583 prevX = x;
87196f1b 584 prevY = y;
ccd9d7c2 585 }
e03d443c 586 else {
87196f1b
WB
587 if(prevX !== null) {
588 if (stepPlot) {
589 ctx.lineTo(x, prevY);
590 ctx.lineTo(x, canvasHeight);
591 }
592 else {
593 ctx.lineTo(prevX, canvasHeight);
594 }
595 }
596 prevX = prevY = null;
597 }
ccd9d7c2
PF
598 }
599 ctx.lineTo(canvasWidth, canvasHeight);
600 ctx.closePath();
601
602 if (fillStyle) {
603 var lingrad = this.bgcanvas_ctx_.createLinearGradient(0, 0, 0, canvasHeight);
79cb28dd 604 if (fillGradientStyle) {
605 lingrad.addColorStop(0, fillGradientStyle);
606 }
ccd9d7c2
PF
607 lingrad.addColorStop(1, fillStyle);
608 this.bgcanvas_ctx_.fillStyle = lingrad;
609 ctx.fill();
610 }
611
612 if (strokeStyle) {
613 this.bgcanvas_ctx_.strokeStyle = strokeStyle;
b77d7a56 614 this.bgcanvas_ctx_.lineWidth = this.getOption_('rangeSelectorPlotLineWidth');
ccd9d7c2
PF
615 ctx.stroke();
616 }
617};
618
619/**
620 * @private
dcebad80
DV
621 * Computes and returns the combined series data along with min/max for the mini plot.
622 * The combined series consists of averaged values for all series.
623 * When series have error bars, the error bars are ignored.
624 * @return {Object} An object containing combined series array, ymin, ymax.
ccd9d7c2 625 */
0d216a60 626rangeSelector.prototype.computeCombinedSeriesAndLimits_ = function() {
dcebad80 627 var g = this.dygraph_;
ec475f44 628 var logscale = this.getOption_('logscale');
bcf7f810 629 var i;
ccd9d7c2 630
0a0885d1
DV
631 // Select series to combine. By default, all series are combined.
632 var numColumns = g.numColumns();
633 var labels = g.getLabels();
634 var includeSeries = new Array(numColumns);
635 var anySet = false;
636 for (i = 1; i < numColumns; i++) {
637 var include = this.getOption_('showInRangeSelector', labels[i]);
638 includeSeries[i] = include;
639 if (include !== null) anySet = true; // it's set explicitly for this series
640 }
641 if (!anySet) {
642 for (i = 0; i < includeSeries.length; i++) includeSeries[i] = true;
1085dbce
PP
643 }
644
0a0885d1 645 // Create a combined series (average of selected series values).
dcebad80
DV
646 // TODO(danvk): short-circuit if there's only one series.
647 var rolledSeries = [];
648 var dataHandler = g.dataHandler_;
649 var options = g.attributes_;
0a0885d1
DV
650 for (i = 1; i < g.numColumns(); i++) {
651 if (!includeSeries[i]) continue;
652 var series = dataHandler.extractSeries(g.rawData_, i, options);
dcebad80
DV
653 if (g.rollPeriod() > 1) {
654 series = dataHandler.rollingAverage(series, g.rollPeriod(), options);
ccd9d7c2 655 }
b77d7a56 656
dcebad80 657 rolledSeries.push(series);
ccd9d7c2
PF
658 }
659
dcebad80
DV
660 var combinedSeries = [];
661 for (i = 0; i < rolledSeries[0].length; i++) {
662 var sum = 0;
663 var count = 0;
bcf7f810 664 for (var j = 0; j < rolledSeries.length; j++) {
dcebad80
DV
665 var y = rolledSeries[j][i][1];
666 if (y === null || isNaN(y)) continue;
667 count++;
668 sum += y;
ccd9d7c2 669 }
dcebad80 670 combinedSeries.push([rolledSeries[0][i][0], sum / count]);
ccd9d7c2
PF
671 }
672
673 // Compute the y range.
674 var yMin = Number.MAX_VALUE;
675 var yMax = -Number.MAX_VALUE;
758a629f 676 for (i = 0; i < combinedSeries.length; i++) {
c0430a23 677 var yVal = combinedSeries[i][1];
758a629f 678 if (yVal !== null && isFinite(yVal) && (!logscale || yVal > 0)) {
ccd9d7c2
PF
679 yMin = Math.min(yMin, yVal);
680 yMax = Math.max(yMax, yVal);
681 }
682 }
683
684 // Convert Y data to log scale if needed.
685 // Also, expand the Y range to compress the mini plot a little.
758a629f 686 var extraPercent = 0.25;
ccd9d7c2
PF
687 if (logscale) {
688 yMax = Dygraph.log10(yMax);
689 yMax += yMax*extraPercent;
690 yMin = Dygraph.log10(yMin);
758a629f 691 for (i = 0; i < combinedSeries.length; i++) {
ccd9d7c2
PF
692 combinedSeries[i][1] = Dygraph.log10(combinedSeries[i][1]);
693 }
694 } else {
695 var yExtra;
5061b42f 696 var yRange = yMax - yMin;
ccd9d7c2
PF
697 if (yRange <= Number.MIN_VALUE) {
698 yExtra = yMax*extraPercent;
699 } else {
700 yExtra = yRange*extraPercent;
701 }
702 yMax += yExtra;
703 yMin -= yExtra;
704 }
705
706 return {data: combinedSeries, yMin: yMin, yMax: yMax};
707};
708
709/**
710 * @private
711 * Places the zoom handles in the proper position based on the current X data window.
712 */
0d216a60 713rangeSelector.prototype.placeZoomHandles_ = function() {
ccd9d7c2
PF
714 var xExtremes = this.dygraph_.xAxisExtremes();
715 var xWindowLimits = this.dygraph_.xAxisRange();
716 var xRange = xExtremes[1] - xExtremes[0];
717 var leftPercent = Math.max(0, (xWindowLimits[0] - xExtremes[0])/xRange);
718 var rightPercent = Math.max(0, (xExtremes[1] - xWindowLimits[1])/xRange);
719 var leftCoord = this.canvasRect_.x + this.canvasRect_.w*leftPercent;
720 var rightCoord = this.canvasRect_.x + this.canvasRect_.w*(1 - rightPercent);
920208fb
PF
721 var handleTop = Math.max(this.canvasRect_.y, this.canvasRect_.y + (this.canvasRect_.h - this.leftZoomHandle_.height)/2);
722 var halfHandleWidth = this.leftZoomHandle_.width/2;
723 this.leftZoomHandle_.style.left = (leftCoord - halfHandleWidth) + 'px';
ccd9d7c2 724 this.leftZoomHandle_.style.top = handleTop + 'px';
920208fb 725 this.rightZoomHandle_.style.left = (rightCoord - halfHandleWidth) + 'px';
ccd9d7c2
PF
726 this.rightZoomHandle_.style.top = this.leftZoomHandle_.style.top;
727
728 this.leftZoomHandle_.style.visibility = 'visible';
729 this.rightZoomHandle_.style.visibility = 'visible';
730};
731
732/**
733 * @private
734 * Draws the interactive layer in the foreground canvas.
735 */
0d216a60 736rangeSelector.prototype.drawInteractiveLayer_ = function() {
ccd9d7c2
PF
737 var ctx = this.fgcanvas_ctx_;
738 ctx.clearRect(0, 0, this.canvasRect_.w, this.canvasRect_.h);
739 var margin = 1;
740 var width = this.canvasRect_.w - margin;
741 var height = this.canvasRect_.h - margin;
742 var zoomHandleStatus = this.getZoomHandleStatus_();
743
fb24d32c 744 ctx.strokeStyle = this.getOption_('rangeSelectorForegroundStrokeColor');
745 ctx.lineWidth = this.getOption_('rangeSelectorForegroundLineWidth');
ccd9d7c2
PF
746 if (!zoomHandleStatus.isZoomed) {
747 ctx.beginPath();
748 ctx.moveTo(margin, margin);
749 ctx.lineTo(margin, height);
750 ctx.lineTo(width, height);
751 ctx.lineTo(width, margin);
752 ctx.stroke();
753 } else {
5061b42f
DV
754 var leftHandleCanvasPos = Math.max(margin, zoomHandleStatus.leftHandlePos - this.canvasRect_.x);
755 var rightHandleCanvasPos = Math.min(width, zoomHandleStatus.rightHandlePos - this.canvasRect_.x);
ccd9d7c2 756
b77d7a56 757 ctx.fillStyle = 'rgba(240, 240, 240, ' + this.getOption_('rangeSelectorAlpha').toString() + ')';
920208fb
PF
758 ctx.fillRect(0, 0, leftHandleCanvasPos, this.canvasRect_.h);
759 ctx.fillRect(rightHandleCanvasPos, 0, this.canvasRect_.w - rightHandleCanvasPos, this.canvasRect_.h);
ccd9d7c2
PF
760
761 ctx.beginPath();
762 ctx.moveTo(margin, margin);
763 ctx.lineTo(leftHandleCanvasPos, margin);
764 ctx.lineTo(leftHandleCanvasPos, height);
765 ctx.lineTo(rightHandleCanvasPos, height);
766 ctx.lineTo(rightHandleCanvasPos, margin);
767 ctx.lineTo(width, margin);
768 ctx.stroke();
769 }
770};
771
772/**
773 * @private
774 * Returns the current zoom handle position information.
775 * @return {Object} The zoom handle status.
776 */
0d216a60 777rangeSelector.prototype.getZoomHandleStatus_ = function() {
920208fb 778 var halfHandleWidth = this.leftZoomHandle_.width/2;
088be40b
PF
779 var leftHandlePos = parseFloat(this.leftZoomHandle_.style.left) + halfHandleWidth;
780 var rightHandlePos = parseFloat(this.rightZoomHandle_.style.left) + halfHandleWidth;
ccd9d7c2
PF
781 return {
782 leftHandlePos: leftHandlePos,
783 rightHandlePos: rightHandlePos,
784 isZoomed: (leftHandlePos - 1 > this.canvasRect_.x || rightHandlePos + 1 < this.canvasRect_.x+this.canvasRect_.w)
785 };
786};
0d216a60
PF
787
788return rangeSelector;
789
790})();