Only add 1 point per pixel for graphs without error bars to speed up rendering.
[dygraphs.git] / dygraph-layout.js
CommitLineData
74a5af31
DV
1// Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
2// All Rights Reserved.
3
4/**
5 * @fileoverview Based on PlotKitLayout, but modified to meet the needs of
6 * dygraphs.
7 */
8
9/**
10 * Creates a new DygraphLayout object.
11 *
12 * This class contains all the data to be charted.
13 * It uses data coordinates, but also records the chart range (in data
14 * coordinates) and hence is able to calculate percentage positions ('In this
15 * view, Point A lies 25% down the x-axis.')
16 *
17 * Two things that it does not do are:
18 * 1. Record pixel coordinates for anything.
19 * 2. (oddly) determine anything about the layout of chart elements.
20 *
21 * The naming is a vestige of Dygraph's original PlotKit roots.
22 *
23 * @constructor
24 */
25DygraphLayout = function(dygraph) {
26 this.dygraph_ = dygraph;
27 this.datasets = new Array();
28 this.annotations = new Array();
29 this.yAxes_ = null;
30
31 // TODO(danvk): it's odd that xTicks_ and yTicks_ are inputs, but xticks and
32 // yticks are outputs. Clean this up.
33 this.xTicks_ = null;
34 this.yTicks_ = null;
35};
36
37DygraphLayout.prototype.attr_ = function(name) {
38 return this.dygraph_.attr_(name);
39};
40
41DygraphLayout.prototype.addDataset = function(setname, set_xy) {
42 this.datasets[setname] = set_xy;
43};
44
45DygraphLayout.prototype.setAnnotations = function(ann) {
46 // The Dygraph object's annotations aren't parsed. We parse them here and
47 // save a copy. If there is no parser, then the user must be using raw format.
48 this.annotations = [];
49 var parse = this.attr_('xValueParser') || function(x) { return x; };
50 for (var i = 0; i < ann.length; i++) {
51 var a = {};
52 if (!ann[i].xval && !ann[i].x) {
53 this.dygraph_.error("Annotations must have an 'x' property");
54 return;
55 }
56 if (ann[i].icon &&
57 !(ann[i].hasOwnProperty('width') &&
58 ann[i].hasOwnProperty('height'))) {
59 this.dygraph_.error("Must set width and height when setting " +
60 "annotation.icon property");
61 return;
62 }
63 Dygraph.update(a, ann[i]);
64 if (!a.xval) a.xval = parse(a.x);
65 this.annotations.push(a);
66 }
67};
68
69DygraphLayout.prototype.setXTicks = function(xTicks) {
70 this.xTicks_ = xTicks;
71};
72
73// TODO(danvk): add this to the Dygraph object's API or move it into Layout.
74DygraphLayout.prototype.setYAxes = function (yAxes) {
75 this.yAxes_ = yAxes;
76};
77
78DygraphLayout.prototype.setDateWindow = function(dateWindow) {
79 this.dateWindow_ = dateWindow;
80};
81
82DygraphLayout.prototype.evaluate = function() {
83 this._evaluateLimits();
84 this._evaluateLineCharts();
85 this._evaluateLineTicks();
86 this._evaluateAnnotations();
87};
88
89DygraphLayout.prototype._evaluateLimits = function() {
90 this.minxval = this.maxxval = null;
91 if (this.dateWindow_) {
92 this.minxval = this.dateWindow_[0];
93 this.maxxval = this.dateWindow_[1];
94 } else {
95 for (var name in this.datasets) {
96 if (!this.datasets.hasOwnProperty(name)) continue;
97 var series = this.datasets[name];
98 if (series.length > 1) {
99 var x1 = series[0][0];
100 if (!this.minxval || x1 < this.minxval) this.minxval = x1;
101
102 var x2 = series[series.length - 1][0];
103 if (!this.maxxval || x2 > this.maxxval) this.maxxval = x2;
104 }
105 }
106 }
107 this.xrange = this.maxxval - this.minxval;
108 this.xscale = (this.xrange != 0 ? 1/this.xrange : 1.0);
109
110 for (var i = 0; i < this.yAxes_.length; i++) {
111 var axis = this.yAxes_[i];
112 axis.minyval = axis.computedValueRange[0];
113 axis.maxyval = axis.computedValueRange[1];
114 axis.yrange = axis.maxyval - axis.minyval;
115 axis.yscale = (axis.yrange != 0 ? 1.0 / axis.yrange : 1.0);
116
117 if (axis.g.attr_("logscale")) {
118 axis.ylogrange = Dygraph.log10(axis.maxyval) - Dygraph.log10(axis.minyval);
119 axis.ylogscale = (axis.ylogrange != 0 ? 1.0 / axis.ylogrange : 1.0);
120 if (!isFinite(axis.ylogrange) || isNaN(axis.ylogrange)) {
121 axis.g.error('axis ' + i + ' of graph at ' + axis.g +
122 ' can\'t be displayed in log scale for range [' +
123 axis.minyval + ' - ' + axis.maxyval + ']');
124 }
125 }
126 }
127};
128
129DygraphLayout.prototype._evaluateLineCharts = function() {
130 // add all the rects
131 this.points = new Array();
132 for (var setName in this.datasets) {
133 if (!this.datasets.hasOwnProperty(setName)) continue;
134
135 var dataset = this.datasets[setName];
136 var axis = this.dygraph_.axisPropertiesForSeries(setName);
137
4ab8db0c
AR
138 var graphWidth = this.dygraph_.width_;
139 var graphHeight = this.dygraph_.height_;
140 var prevXPx = NaN;
141 var prevYPx = NaN;
142 var currXPx = NaN;
143 var currYPx = NaN;
144
145 var errorBars = this.attr_("errorBars") || this.attr_("customBars");
146
74a5af31
DV
147 for (var j = 0; j < dataset.length; j++) {
148 var item = dataset[j];
4ab8db0c
AR
149 var xValue = parseFloat(dataset[j][0]);
150 var yValue = parseFloat(dataset[j][1]);
151
152 // Range from 0-1 where 0 represents top and 1 represents bottom
153 var xNormal = (xValue - this.minxval) * this.xscale;
154 // Range from 0-1 where 0 represents left and 1 represents right.
155 var yNormal;
74a5af31 156 if (axis.logscale) {
4ab8db0c 157 yNormal = 1.0 - ((Dygraph.log10(yValue) - Dygraph.log10(axis.minyval)) * axis.ylogscale);
74a5af31 158 } else {
4ab8db0c
AR
159 yNormal = 1.0 - ((yValue - axis.minyval) * axis.yscale);
160 }
161
162 // Current pixel coordinates that the data point would fill.
163 currXPx = Math.round(xNormal * graphWidth);
164 currYPx = Math.round(yNormal * graphHeight);
165
166 // Skip over pushing points that lie on the same pixel.
167 // Ignore this optimization if there are error bars.
168 // TODO(antrob): optimize this for graphs with error bars.
169 if (prevXPx != currXPx || prevYPx != currYPx || errorBars) {
170 // TODO(antrob): skip over points that lie on a line that is already going to be drawn.
171 // There is no need to have more than 2 consecutive points that are collinear.
172 var point = {
173 // TODO(danvk): here
174 x: xNormal,
175 y: yNormal,
176 xval: xValue,
177 yval: yValue,
178 name: setName
179 };
180 this.points.push(point);
74a5af31 181 }
4ab8db0c
AR
182 prevXPx = currXPx;
183 prevYPx = currYPx;
74a5af31
DV
184 }
185 }
186};
187
188DygraphLayout.prototype._evaluateLineTicks = function() {
189 this.xticks = new Array();
190 for (var i = 0; i < this.xTicks_.length; i++) {
191 var tick = this.xTicks_[i];
192 var label = tick.label;
193 var pos = this.xscale * (tick.v - this.minxval);
194 if ((pos >= 0.0) && (pos <= 1.0)) {
195 this.xticks.push([pos, label]);
196 }
197 }
198
199 this.yticks = new Array();
200 for (var i = 0; i < this.yAxes_.length; i++ ) {
201 var axis = this.yAxes_[i];
202 for (var j = 0; j < axis.ticks.length; j++) {
203 var tick = axis.ticks[j];
204 var label = tick.label;
205 var pos = this.dygraph_.toPercentYCoord(tick.v, i);
206 if ((pos >= 0.0) && (pos <= 1.0)) {
207 this.yticks.push([i, pos, label]);
208 }
209 }
210 }
211};
212
213
214/**
215 * Behaves the same way as PlotKit.Layout, but also copies the errors
216 * @private
217 */
218DygraphLayout.prototype.evaluateWithError = function() {
219 this.evaluate();
220 if (!(this.attr_('errorBars') || this.attr_('customBars'))) return;
221
222 // Copy over the error terms
223 var i = 0; // index in this.points
224 for (var setName in this.datasets) {
225 if (!this.datasets.hasOwnProperty(setName)) continue;
226 var j = 0;
227 var dataset = this.datasets[setName];
228 for (var j = 0; j < dataset.length; j++, i++) {
229 var item = dataset[j];
230 var xv = parseFloat(item[0]);
231 var yv = parseFloat(item[1]);
232
233 if (xv == this.points[i].xval &&
234 yv == this.points[i].yval) {
235 this.points[i].errorMinus = parseFloat(item[2]);
236 this.points[i].errorPlus = parseFloat(item[3]);
237 }
238 }
239 }
240};
241
242DygraphLayout.prototype._evaluateAnnotations = function() {
243 // Add the annotations to the point to which they belong.
244 // Make a map from (setName, xval) to annotation for quick lookups.
245 var annotations = {};
246 for (var i = 0; i < this.annotations.length; i++) {
247 var a = this.annotations[i];
248 annotations[a.xval + "," + a.series] = a;
249 }
250
251 this.annotated_points = [];
d570a072
AR
252
253 // Exit the function early if there are no annotations.
254 if (!this.annotations || !this.annotations.length) {
255 return;
256 }
257
258 // TODO(antrob): loop through annotations not points.
74a5af31
DV
259 for (var i = 0; i < this.points.length; i++) {
260 var p = this.points[i];
261 var k = p.xval + "," + p.name;
262 if (k in annotations) {
263 p.annotation = annotations[k];
264 this.annotated_points.push(p);
265 }
266 }
267};
268
269/**
270 * Convenience function to remove all the data sets from a graph
271 */
272DygraphLayout.prototype.removeAllDatasets = function() {
273 delete this.datasets;
274 this.datasets = new Array();
275};
276
277/**
278 * Return a copy of the point at the indicated index, with its yval unstacked.
279 * @param int index of point in layout_.points
280 */
281DygraphLayout.prototype.unstackPointAtIndex = function(idx) {
282 var point = this.points[idx];
283
284 // Clone the point since we modify it
285 var unstackedPoint = {};
286 for (var i in point) {
287 unstackedPoint[i] = point[i];
288 }
289
290 if (!this.attr_("stackedGraph")) {
291 return unstackedPoint;
292 }
293
294 // The unstacked yval is equal to the current yval minus the yval of the
295 // next point at the same xval.
296 for (var i = idx+1; i < this.points.length; i++) {
297 if (this.points[i].xval == point.xval) {
298 unstackedPoint.yval -= this.points[i].yval;
299 break;
300 }
301 }
302
303 return unstackedPoint;
304}