From dde90a167b61a5bbe4da99c3b22bb5a3399a8ac0 Mon Sep 17 00:00:00 2001 From: Dan Vanderkam Date: Tue, 23 Mar 2010 06:33:28 -0700 Subject: [PATCH] add test references to docs --- docs/index.html | 125 +++++++++++++++++++++++++++++++++++++------------- tests/dateWindow.html | 6 --- 2 files changed, 93 insertions(+), 38 deletions(-) diff --git a/docs/index.html b/docs/index.html index 718c298..3f6bfb6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -490,32 +490,42 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) includeZero boolean false - Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data. + Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data. +
Tests: no-range numeric-gviz small-range-zero + rollPeriod integer >= 1 1 - Number of days over which to average data. Discussed extensively above. + Number of days over which to average data. Discussed extensively above. +
Tests: demo two-series noise + showRoller boolean false - If the rolling average period text box should be shown. + If the rolling average period text box should be shown. +
Tests: callback crosshair fractions isolated-points numeric-gviz underlay-callback + colors ['red', '#00FF00'] - List of colors for the data series. These can be of the form "#AABBCC" or "rgb(255,100,200)" or "yellow", etc. If not specified, equally-spaced points around a color wheel are used. + List of colors for the data series. These can be of the form "#AABBCC" or "rgb(255,100,200)" or "yellow", etc. If not specified, equally-spaced points around a color wheel are used. +
Tests: color-visibility demo + fillGraph boolean
 false Should the area underneath the graph be filled? This option is not - compatible with error bars. + compatible with error bars. +
Tests: fillGraph + visibility @@ -524,111 +534,145 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) Which series should initially be visible? Once the Dygraph has been constructed, you can access and modify the visibility of each series using the visibility and - setVisibility methods. See the visibility demo for an example. + setVisibility methods. +
Tests: visibility color-visibility colorSaturation 0.0 - 1.0 1.0 - If colors is not specified, saturation of the automatically-generated data series colors. + If colors is not specified, saturation of the automatically-generated data series colors. +
Tests: none + colorValue float (0.0 — 1.0) 1.0 - If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5) + If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5) +
Tests: none + clickCallback function(e, date){
    alert(date);
} null - A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked. (default null) + A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked. (default null) +
Tests: callback + zoomCallback function(minDate,
maxDate){} null - A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. + A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. +
Tests: callback + strokeWidth integer 1 - Width of the data lines. This can be used to increase the contrast or some graphs. + Width of the data lines. This can be used to increase the contrast or some graphs. +
Tests: none + dateWindow [
  Date.parse('2006-01-01'),
  (new Date()).valueOf()
] Full range of the
input is shown - Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. + Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. +
Tests: dateWindow link-interaction + valueRange [10, 110] - Explicitly set the vertical range of the graph to [low, high]. + Explicitly set the vertical range of the graph to [low, high]. +
Tests: none + labelsSeparateLines boolean false - Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. + Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. +
Tests: customLabel demo + labelsDiv document.
getElementById('foo') null - Show data labels in an external div, rather than on the graph. + Show data labels in an external div, rather than on the graph. +
Tests: demo label-div + labelsKMB true false - Show K/M/B for thousands/millions/billions on y-axis. + Show K/M/B for thousands/millions/billions on y-axis. +
Tests: demo labelsKMB no-range + labelsKMG2 true false Show k/M/G for kilo/Mega/Giga on y-axis. This is different than - labelsKMB in that it uses base 2, not 10. + labelsKMB in that it uses base 2, not 10. +
Tests: labelsKMB + labelsDivWidth 250 - Width (in pixels) of the div which shows information on the currently-highlighted points. + Width (in pixels) of the div which shows information on the currently-highlighted points. +
Tests: customLabel + labelsDivStyles {} null - Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold. + Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold. +
Tests: border customLabel + highlightCircleSize integer 3 - The size in pixels of the dot drawn over highlighted points. + The size in pixels of the dot drawn over highlighted points. +
Tests: grid_dot + drawPoints boolean false - 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. + 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. +
Tests: draw-points + pointSize interger 1 - The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is "isolated", i.e. there is a missing point on either side of it. This also controls the size of those dots. + The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is "isolated", i.e. there is a missing point on either side of it. This also controls the size of those dots. +
Tests: none + pixelsPerXLabel integer 60 - Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks. + Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks. +
Tests: spacing + pixelsPerYLabel @@ -638,7 +682,9 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) xAxisLabelWidth integer - Width (in pixels) of the x- and y-axis labels. + Width (in pixels) of the x- and y-axis labels. +
Tests: customLabel + yAxisLabelWidth @@ -648,43 +694,57 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) axisLabelFontSize integer 14 - Size of the font (in pixels) to use in the axis labels, both x- and y-axis. + Size of the font (in pixels) to use in the axis labels, both x- and y-axis. +
Tests: none + rightGap integer - Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point. + Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point. +
Tests: none + errorBars boolean false - Does the data contain standard deviations? Setting this to true alters the input format (see above). + Does the data contain standard deviations? Setting this to true alters the input format (see above). +
Tests: noise customLabel draw-points fillGraph fractions + sigma integer - When errorBars is set, shade this many standard deviations above/below each point. + When errorBars is set, shade this many standard deviations above/below each point. +
Tests: none + fractions boolean false - When set, attempt to parse each cell in the CSV file as "a/b", where a and b are integers. The ratio will be plotted. This allows computation of Wilson confidence intervals (see below). + When set, attempt to parse each cell in the CSV file as "a/b", where a and b are integers. The ratio will be plotted. This allows computation of Wilson confidence intervals (see below). +
Tests: fractions + wilsonInterval boolean true - Use in conjunction with the "fractions" option. Instead of plotting +/- N standard deviations, dygraphs will compute a Wilson confidence interval and plot that. This has more reasonable behavior for ratios close to 0 or 1. + Use in conjunction with the "fractions" option. Instead of plotting +/- N standard deviations, dygraphs will compute a Wilson confidence interval and plot that. This has more reasonable behavior for ratios close to 0 or 1. +
Tests: none + customBars boolean false - When set, parse each CSV cell as "low;middle;high". Error bars will be drawn for each point between low and high, with the series itself going through middle. + When set, parse each CSV cell as "low;middle;high". Error bars will be drawn for each point between low and high, with the series itself going through middle. +
Tests: custom-bars zero-series + @@ -694,6 +754,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)

Here are a few problems that I've frequently run into while using the dygraphs library.