Fix documentation for underlayCallback (Issue 379)
authorDan Vanderkam <danvdk@gmail.com>
Fri, 8 Feb 2013 19:59:29 +0000 (14:59 -0500)
committerDan Vanderkam <danvdk@gmail.com>
Fri, 8 Feb 2013 19:59:29 +0000 (14:59 -0500)
dygraph-options-reference.js

index 0f601d1..a3392d9 100644 (file)
@@ -269,10 +269,10 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
   "underlayCallback": {
     "default": "null",
     "labels": ["Callbacks"],
-    "type": "function(canvas, area, dygraph)",
+    "type": "function(context, area, dygraph)",
     "parameters": [
-      [ "canvas" , "the canvas to draw on" ],
-      [ "area" , "" ],
+      [ "context" , "the canvas drawing context on which to draw" ],
+      [ "area" , "An object with {x,y,w,h} properties describing the drawing area." ],
       [ "dygraph" , "the reference graph" ]
     ],
     "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."