Add useful comments to some of the mousedispatch methods.
authorRobert Konigsberg <konigsberg@google.com>
Thu, 2 Jun 2011 19:55:08 +0000 (15:55 -0400)
committerRobert Konigsberg <konigsberg@google.com>
Thu, 2 Jun 2011 19:55:08 +0000 (15:55 -0400)
auto_tests/tests/DygraphOps.js

index ad67b2a..5dfa2be 100644 (file)
@@ -139,6 +139,10 @@ DygraphOps.dispatchMouseUp_Point = function(g, x, y, custom) {
   g.canvas_.dispatchEvent(event);
 };
 
   g.canvas_.dispatchEvent(event);
 };
 
+/**
+ * Dispatches a mouse down using the graph's data coordinate system.
+ * (The y value mapped to the first axis.)
+ */
 DygraphOps.dispatchMouseDown = function(g, x, y, custom) {
   DygraphOps.dispatchMouseDown_Point(
       g,
 DygraphOps.dispatchMouseDown = function(g, x, y, custom) {
   DygraphOps.dispatchMouseDown_Point(
       g,
@@ -147,6 +151,10 @@ DygraphOps.dispatchMouseDown = function(g, x, y, custom) {
       custom);
 };
 
       custom);
 };
 
+/**
+ * Dispatches a mouse move using the graph's data coordinate system.
+ * (The y value mapped to the first axis.)
+ */
 DygraphOps.dispatchMouseMove = function(g, x, y, custom) {
   DygraphOps.dispatchMouseMove_Point(
       g,
 DygraphOps.dispatchMouseMove = function(g, x, y, custom) {
   DygraphOps.dispatchMouseMove_Point(
       g,
@@ -155,6 +163,10 @@ DygraphOps.dispatchMouseMove = function(g, x, y, custom) {
       custom);
 };
 
       custom);
 };
 
+/**
+ * Dispatches a mouse up using the graph's data coordinate system.
+ * (The y value mapped to the first axis.)
+ */
 DygraphOps.dispatchMouseUp = function(g, x, y, custom) {
   DygraphOps.dispatchMouseUp_Point(
       g,
 DygraphOps.dispatchMouseUp = function(g, x, y, custom) {
   DygraphOps.dispatchMouseUp_Point(
       g,