re-add 'validate eventName' TODO.
[dygraphs.git] / dygraph-options-reference.js
index cb8b767..6a72616 100644 (file)
@@ -35,17 +35,13 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
     "default": "null",
     "labels": ["Legend"],
     "type": "{}",
-    "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
+    "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'fontWeight': 'bold' } will make the labels bold. In general, it is better to use CSS to style the .dygraph-legend class than to use this property."
   },
   "drawPoints": {
     "default": "false",
     "labels": ["Data Line display"],
     "type": "boolean",
-    "description": "Draw a small dot at each point, in addition to a line going through \
-        the point. This makes the individual data points easier to see, but  \
-        can increase visual clutter in the chart. The small dot can be \
-        replaced with a custom rendering by supplying a \
-        <a href='#drawPointCallback'>drawPointCallback</a>."
+    "description": "Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart. The small dot can be replaced with a custom rendering by supplying a <a href='#drawPointCallback'>drawPointCallback</a>."
   },
   "drawPointCallback": {
     "default": "null",
@@ -60,17 +56,13 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
       [ "color" , "series color" ],
       [ "pointSize" , "the radius of the image." ]
     ],
-    "description": "Draw a custom item when drawPoints is enabled. \
-        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='#drawHighlightPointCallback'>drawHighlightPointCallback</a>"
+    "description": "Draw a custom item when drawPoints is enabled. 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='#drawHighlightPointCallback'>drawHighlightPointCallback</a>"
   },
   "height": {
     "default": "320",
     "labels": ["Overall display"],
     "type": "integer",
-    "description": "Height, in pixels, of the chart. If the container div has \
-      been explicitly sized, this will be ignored."
+    "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
   },
   "zoomCallback": {
     "default": "null",
@@ -81,8 +73,7 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
       [ "maxDate" , "milliseconds since epoch." ],
       [ "yRanges" , "is an array of [bottom, top] pairs, one for each y-axis." ]
     ],
-    "description": "A function to call when the zoom window is changed (either \
-      by zooming in or out)."
+    "description": "A function to call when the zoom window is changed (either by zooming in or out)."
   },
   "pointClickCallback": {
     "snippet": "function(e, point){<br>&nbsp;&nbsp;alert(point);<br>}",
@@ -134,10 +125,7 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
       [ "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>"
+    "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",
@@ -376,7 +364,7 @@ Dygraph.OPTIONS_REFERENCE =  // <JSON>
     "labels": ["Data Line display"],
     "type": "array<integer>",
     "example": "[10, 2, 5, 2]",
-    "description": "A custom pattern array where the even index is a draw and odd is a space in pixels. If null then it draws a solid line. The array should have a even length as any odd lengthed array could be expressed as a smaller even length array."
+    "description": "A custom pattern array where the even index is a draw and odd is a space in pixels. If null then it draws a solid line. The array should have a even length as any odd lengthed array could be expressed as a smaller even length array. This is used to create dashed lines."
   },
   "strokeBorderWidth": {
     "default": "null",