Update document reference; add docs for pointClickCallback, and clarify
authorRobert Konigsberg <konigsberg@google.com>
Thu, 9 Jun 2011 20:39:36 +0000 (16:39 -0400)
committerRobert Konigsberg <konigsberg@google.com>
Thu, 9 Jun 2011 20:39:36 +0000 (16:39 -0400)
clickCallback.

dygraph-options-reference.js

index 6ba8f8e..6dd081e 100644 (file)
@@ -47,10 +47,11 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
     "description": "A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. yRanges is an array of [bottom, top] pairs, one for each y-axis."
   },
   "pointClickCallback": {
-    "default": "",
+    "snippet": "function(e, point){<br>&nbsp;&nbsp;alert(point);<br>}",
+    "default": "null",
     "labels": ["Callbacks", "Interactive Elements"],
-    "type": "",
-    "description": ""
+    "type": "function(e, point)",
+    "description": "A function to call when a data point is clicked. The function should take two arguments, the event object for the click, and the point that was clicked."
   },
   "colors": {
     "default": "(see description)",
@@ -354,8 +355,9 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
     "snippet": "function(e, date){<br>&nbsp;&nbsp;alert(date);<br>}",
     "default": "null",
     "labels": ["Callbacks"],
-    "type": "function(e, date)",
-    "description": "A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked."
+    "type": "function(e, date, points)",
+    // NOTE(konigsberg): Is this description correct?
+    "description": "A function to call when the canvas is clicked. The function should take three arguments, the event object for the click, the date that was clicked, and the closest points along that date."
   },
   "yAxisLabelFormatter": {
     "default": "yValueFormatter",