X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Findex.html;h=1a86ecc4d68210c2e2876a7b3b3f1772c6d99b9e;hb=71ac4733fec0ca3adab2ae5440db13e1cd2231f1;hp=718c298ddef673b3fcc3461a009ee2fab41f45fe;hpb=50360fd082e74dd47cdc95b96892fef7f2067ce9;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index 718c298..1a86ecc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,6 +19,7 @@
  • Baseball chart
  • Stock chart
  • Options Reference
    • +
  • GWT Compatibility
  • Data Policy
    • @@ -38,7 +39,7 @@
  • Performance Test
  • Filled Chart
  • Fractions
    • -
  • Visibility
    • +
  • Visibility
  • Labels in a DIV
  • Numeric Axis
  • Dotted Points
    • @@ -474,7 +475,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)

    Other Options

    -

    These are the options that can be passed in through the optional third parameter of the Dygraph constructor. To see demonstrations of many of these options, browse the dygraphs tests directory.

    +

    These are the options that can be passed in through the optional third parameter of the Dygraph constructor. Under each option is a set of links to tests which demonstrate its use. While we attempt to keep this list up-to-date, a more complete list can be found in the Dygraph.DEFAULT_ATTRS map in dygraph.js and the this.options map in dygraph-canvas.js.

    @@ -490,32 +491,42 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) - + - + - + - + + compatible with error bars. +
    Tests: fillGraph
    + @@ -524,111 +535,145 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) + setVisibility methods. +
    Tests: visibility color-visibility
    - + - + - + - + - + - + - + - + - + - + + labelsKMB in that it uses base 2, not 10. +
    Tests: labelsKMB
    + - + - + - + - + - + - + @@ -638,7 +683,9 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) - + @@ -648,44 +695,124 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) - + + + + + + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    includeZero boolean falseUsually, 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 1Number 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 falseIf 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.
    visibilityWhich 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.
    colorSaturation 0.0 - 1.0 1.0If 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.0If 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);
    }    		 nullA 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){}    		 nullA 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 1Width 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 falsePut <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')    		 nullShow 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 falseShow 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.
    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 {} nullAdditional 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 3The 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 falseDraw 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 1The 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 60Number 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
    +
    pixelsPerYLabelxAxisLabelWidth integer Width (in pixels) of the x- and y-axis labels.Width (in pixels) of the x- and y-axis labels. +
    Tests: customLabel
    +
    yAxisLabelWidthaxisLabelFontSize integer 14Size 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
    +
    xAxisLabelFormatterfunction(date, granularity)Dygraph.dateAxisFormatterFunction to call to format values along the x axis. +
    Tests: xAxisLabelFormatter
    +
    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 falseDoes 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 falseWhen 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 trueUse 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 falseWhen 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
    +
    drawCallbackfunction(dygraph, is_initial)nullWhen set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning. The first parameter is the dygraph being drawn. The second is a boolean value indicating whether this is the initial draw. +
    Tests: callback synchronize
    +
    gridLineColorred, bluergb(128,128,128)The color of the gridlines. +
    Tests: grid_dot
    +
    highlightCallbackfunction(event, x, points)nullWhen set, this callback gets called every time a new point is highlighted. The parameters are the JavaScript mousemove event, the x-coordinate of the highlighted points and an array of highlighted points: [ {name: 'series', yval: y-value}, … ] +
    Tests: callback crosshair
    +
    unhighlightCallbackfunction(event)nullWhen set, this callback gets called every time the user stops highlighting any point by mousing out of the graph. The parameter is the mouseout event. +
    Tests: callback crosshair
    +
    strokeWidth0.5, 2.01.0The width of the lines connecting data points. +
    Tests: grid_dot
    +
    widthinteger480Width/Height (in pixels) of the chart. If the container div has been explicitly sized, these attributes will be ignored. +
    Tests: demo link-interaction no-range
    +
    height320
    @@ -694,6 +821,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.

    +

    GWT Compatibility

    +

    There is currently no GWT wrapper around Dygraphs, however there is a class that can be used to easily load Dygraphs into the browser. To use it, include the generated dygraph-gwt.jar file in your classpath and add the following line to your GWT module:

    + +
    +<inherits name="org.danvk.dygraphs"/>    
+
    + +

    Call org.danvk.Dygraphs.install() when your application starts to install the JavaScript code into the browser. You can use JSNI to call Dygraphs from your GWT code, as in the example below. The example uses the Visualization API for GWT and the Dygraphs GViz API.

    + +
    +  public static native JavaScriptObject drawDygraph(Element element, DataTable data, double minY, double maxY) /*-{
+    var chart = new $wnd.Dygraph.GVizChart(element);
+    chart.draw(dataTable,
+      {
+        valueRange: [minY, maxY]
+      });
+    return chart;
+  }-*/;
+
    +

    Data Policy

    dygraphs is purely client-side JavaScript. It does not send your data to any servers – the data is processed entirely in the client's browser.