From 672f92a0ad926bc4d01cbffc2f165c28f56b7b25 Mon Sep 17 00:00:00 2001 From: Dan Vanderkam Date: Thu, 26 Nov 2009 21:30:51 -0500 Subject: [PATCH] update docs --- docs/index.html | 156 +++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 126 insertions(+), 30 deletions(-) diff --git a/docs/index.html b/docs/index.html index 4ea19c8..ab81d90 100644 --- a/docs/index.html +++ b/docs/index.html @@ -82,7 +82,6 @@ "#00DD55", "rgba(50,50,200,0.4)"], padding: {left: 40, right: 30, top: 15, bottom: 15}, - strokeWidth: 3.0 } ); @@ -322,84 +321,181 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) rollPeriod 7 Number of days over which to average data. Discussed extensively above. - + + + showRoller true Should the rolling average period text box be shown? Default is false. - + + + 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. - + + + colorSaturation 1.0 If colors is not specified, saturation of the automatically-generated data series colors. (0.0-1.0, default: 1.0) - + + + colorValue 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) - + + + clickCallback function(e,date){ alert(date); } 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) - - errorBars - false - Does the data contain standard deviations? Setting this to true alters - the input format (see above). (default false) - + + + + zoomCallback + function(minDate,maxDate) {} + A function to call when the zoom window is changed (either by zooming + in or out). minDate and maxDate are millis since epoch. + + + strokeWidth 2.0 Width of the data lines. This can be used to increase the contrast or some graphs. (default 1.0) - + + + dateWindow - [(new Date('2006-01-01')).valueOf(),
+ [Date.parse('2006-01-01'),
(new Date()).valueOf()] Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are millis since epoch. By default, the full range of the input is shown. - + + + valueRange [10, 110] Explicitly set the vertical range of the graph to [low, high]. By default, some clever heuristics are used (see above). - - minTickSize - 1 - The difference between ticks on the y-axis can be greater than or equal - to this, but no less. If you set it to 1, for instance, you'll never get - nonintegral gaps between ticks. - + + + labelsSeparateLines true Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. (default false) - + + + labelsDiv document.getElementById('foo') Show data labels in an external div, rather than on the graph. (default null) - + + + labelsKMB true Show K/M/B for thousands/millions/billions on y-axis (default false). + + + labelsDivWidth + 250 + Width (in pixels) of the div which shows information on the + currently-highlighted points. + + + + labelsDivStyles + {} + Additional styles to apply to the currently-highlighted points div. For + example, { 'font-weigth': 'bold' } will make the labels bold. + + + + highlightCircleSize + 3 + Size (in pixels) of the dot drawn over highlighted points (default 3). + + + + pixelsPerXLabel, pixelsPerYLabel + 50 + Number of pixels to require between each x- and y-label. Larger values + will yield a sparser axis with fewer ticks. Defaults: 60 (x-axis), 30 + (y-axis). + + + + xAxisLabelWidth, yAxisLabelWidth + 50 + Width (in pixels) of the x- and y-axis labels. + + + + axisLabelFontSize + 14 + Size of the font (in pixels) to use in the axis labels, both x- and + y-axis. + + + + rightGap + 5 + Number of pixels to leave blank at the right edge of the Dygraph. This + makes it easier to highlight the right-most data point. + + + + errorBars + false + Does the data contain standard deviations? Setting this to true alters + the input format (see above). (default false) + + + + sigma + 2 + When errorBars is set, shade this many standard deviations above/below + each point. + + + + fractions + 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). + + + + wilsonInterval + 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. + + - padding - {left: 40, right: 30,
top: 5, - bottom: 15} - Adds extra pixels of padding around the graph. Sometimes a dygraph - gets clipped by surrounding text (see the Demo at the top of this page). - Setting this property appropriately will fix this problem. + customBars + 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. -- 2.7.4