Delete multiple_axes-old properly. Keep it dead, dead, dead.

[dygraphs.git] / dygraph-types.js

diff --git a/dygraph-types.js b/dygraph-types.js
index 4e90693..4434758 100644 (file)
--- a/dygraph-types.js
+++ b/dygraph-types.js
@@ -1,3 +1,9 @@
+/**
+ * @license
+ * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
+ * MIT-licensed (http://opensource.org/licenses/MIT)
+ */
+
 // This file contains typedefs and externs that are needed by the Closure Compiler.
 
 /**
@@ -14,3 +20,27 @@
  */
 var DygraphInteractionContext;
 
+/**
+ * Point structure.
+ *
+ * xval_* and yval_* are the original unscaled data values,
+ * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
+ * yval_stacked is the cumulative Y value used for stacking graphs,
+ * and bottom/top/minus/plus are used for error bar graphs.
+ *
+ * @typedef {{
+ *     idx: number,
+ *     name: string,
+ *     x: ?number,
+ *     xval: ?number,
+ *     y_bottom: ?number,
+ *     y: ?number,
+ *     y_stacked: ?number,
+ *     y_top: ?number,
+ *     yval_minus: ?number,
+ *     yval: ?number,
+ *     yval_plus: ?number,
+ *     yval_stacked
+ * }}
+ */
+Dygraph.PointType;