X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=dygraph-options-reference.js;h=97b410f480be0a20baca01ed7a2307499f6a7eee;hb=a5a507274e6a58f70f8c9017d063210c8b78583b;hp=bc5867e3624bcf4a42bc3318f009104c3958c52e;hpb=2a02e5dde7f3727c1735761b84ca41c0f241dcaf;p=dygraphs.git diff --git a/dygraph-options-reference.js b/dygraph-options-reference.js index bc5867e..97b410f 100644 --- a/dygraph-options-reference.js +++ b/dygraph-options-reference.js @@ -35,17 +35,19 @@ Dygraph.OPTIONS_REFERENCE = // "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 \ - drawPointCallback." + "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 drawPointCallback." + }, + "drawGapEdgePoints": { + "default": "false", + "labels": ["Data Line display"], + "type": "boolean", + "description": "Draw points at the edges of gaps in the data. This improves visibility of small data segments or other data irregularities." }, "drawPointCallback": { "default": "null", @@ -60,17 +62,13 @@ Dygraph.OPTIONS_REFERENCE = // [ "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 drawHighlightPointCallback" + "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 drawHighlightPointCallback" }, "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 +79,7 @@ Dygraph.OPTIONS_REFERENCE = // [ "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){
  alert(point);
}", @@ -134,10 +131,7 @@ Dygraph.OPTIONS_REFERENCE = // [ "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 drawPointCallback" + "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 drawPointCallback" }, "highlightSeriesOpts": { "default": "null", @@ -145,11 +139,11 @@ Dygraph.OPTIONS_REFERENCE = // "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": { + "highlightSeriesBackgroundAlpha": { "default": "0.5", "labels": ["Interactive Elements"], "type": "float", - "description": "When nonzero, dim the background while highlighting series. 0=fully visible background, 1=hiddden background (show highlighted series only)." + "description": "Fade the background while highlighting series. 1=fully visible background (disable fading), 0=hiddden background (show highlighted series only)." }, "includeZero": { "default": "false", @@ -376,7 +370,7 @@ Dygraph.OPTIONS_REFERENCE = // "labels": ["Data Line display"], "type": "array", "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",