Merge branch 'master' of git://github.com/danvk/dygraphs into highlight3
authorKlaus Weidner <klausw@google.com>
Sun, 26 Feb 2012 00:04:41 +0000 (16:04 -0800)
committerKlaus Weidner <klausw@google.com>
Sun, 26 Feb 2012 00:04:41 +0000 (16:04 -0800)
1  2 
dygraph-options-reference.js

@@@ -107,26 -124,20 +125,38 @@@ Dygraph.OPTIONS_REFERENCE =  // <JSON
      "default": "null",
      "labels": ["Data Line display"],
      "type": "function(g, seriesName, canvasContext, cx, cy, color, pointSize)",
-     "description": "Draw a custom item when a point is highlighted. Default is a small dot matching the series color."
+     "parameters": [
+       [ "g" , "the reference graph" ],
+       [ "seriesName" , "the name of the series" ],
+       [ "canvasContext" , "the canvas to draw on" ],
+       [ "cx" , "center x coordinate" ],
+       [ "cy" , "center y coordinate" ],
+       [ "color" , "series color" ],
+       [ "pointSize" , "the radius of the image." ]
+     ],
+     "description": "Draw a custom item when a point is highlighted. \
+         Default is a small dot matching the series color. This method \
+         should constrain drawing to within pointSize pixels from (cx, cy) \
+         Also see <a href='#drawPointCallback'>drawPointCallback</a>"
    },
 +  "highlightSeriesOpts": {
 +    "default": "null",
 +    "labels": ["Interactive Elements"],
 +    "type": "Object",
 +    "description": "When set, the options from this object are applied to the timeseries closest to the mouse pointer for interactive highlighting. See also 'highlightCallback'. Example: highlightSeriesOpts: { strokeWidth: 3 }."
 +  },
 +  "highlightSeriesBackgroundFade": {
 +    "default": "0",
 +    "labels": ["Interactive Elements"],
 +    "type": "number",
 +    "description": "When nonzero, dim the background while highlighting series. 0=fully visible, 1=hidden"
 +  },
 +  "highlightSeriesAnimate": {
 +    "default": "false",
 +    "labels": ["Interactive Elements"],
 +    "type": "boolean",
 +    "description": "Animate the background dimming for nonzero highlightSeriesBackgroundFade."
 +  },
    "includeZero": {
      "default": "false",
      "labels": ["Axis display"],