X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Findex.html;h=43695889ec96fe02e83bb2268e818808181e4d00;hb=5ed061d6e6208d1b3f05a0ccd2010c6ce087b674;hp=3f6bfb6ebb1e426bef835640626ab252e0403e92;hpb=dde90a167b61a5bbe4da99c3b22bb5a3399a8ac0;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index 3f6bfb6..4369588 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
  • @@ -57,7 +58,8 @@
  • Negative Numbers
  • Noisy Data
  • Multiple Series
  • -
  • Custom Underlay / background
  • +
  • Custom Underlay / background
  • +
  • Tests for zoom operations
  • @@ -71,7 +73,7 @@

    A demo is worth a thousand words:

    -

    (Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom back out. Change the number and hit enter to adjust the averaging period.)

    +

    (Mouse over to highlight individual values. Click and drag to zoom in both axes. Double-click to zoom back out. Change the number and hit enter to adjust the averaging period.)

    Temperatures in New York vs. San Francisco
    @@ -112,7 +114,7 @@
  • Lightweight (45kb) and responsive
  • Displays values on mouseover (this makes it easily discoverable)
  • Supports error bands around data series
  • -
  • Interactive zoom
  • +
  • Interactive zoom and pan
  • Adjustable averaging period
  • Can intelligently chart fractions
  • Customizable click-through actions
  • @@ -474,7 +476,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.

    @@ -491,7 +493,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -499,7 +501,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -507,7 +509,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -515,7 +517,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -524,7 +526,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -535,7 +537,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) been constructed, you can access and modify the visibility of each series using the visibility and setVisibility methods. -
    Tests: visibility color-visibility +
    Tests: visibility color-visibility
    @@ -543,7 +545,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -551,7 +553,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -559,15 +561,15 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) - + - @@ -575,7 +577,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -583,14 +585,14 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -598,15 +600,23 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) - + - + + + + + + @@ -614,7 +624,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -623,7 +633,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -631,7 +641,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -639,7 +649,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -647,7 +657,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -655,7 +665,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -663,7 +673,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -671,7 +681,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -683,7 +693,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -695,15 +705,22 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) + + + + + @@ -711,7 +728,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -719,7 +736,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -727,7 +744,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -735,7 +752,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) @@ -743,9 +760,68 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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. -
    Tests: no-range numeric-gviz small-range-zero +
    integer >= 1 1 Number of days over which to average data. Discussed extensively above. -
    Tests: demo two-series noise +
    boolean false If the rolling average period text box should be shown. -
    Tests: callback crosshair fractions isolated-points numeric-gviz underlay-callback +
    ['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. -
    Tests: color-visibility demo +
    false Should the area underneath the graph be filled? This option is not compatible with error bars. -
    Tests: fillGraph +
    Tests: fillGraph
    0.0 - 1.0 1.0 If colors is not specified, saturation of the automatically-generated data series colors. -
    Tests: none +
    Tests: none
    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) -
    Tests: none +
    Tests: none
    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) -
    Tests: callback +
    Tests: callback
    zoomCallbackfunction(minDate,
    maxDate){}
    function(minDate,
    maxDate,
    minValue,
    maxValue){}
    nullA function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. -
    Tests: callback +
    A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. minValue and maxValue are y-axis range values. +
    Tests: callback zoom
    integer 1 Width of the data lines. This can be used to increase the contrast or some graphs. -
    Tests: none +
    Tests: none
    [
      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. -
    Tests: dateWindow link-interaction +
    valueRange [10, 110] Explicitly set the vertical range of the graph to [low, high]. -
    Tests: none +
    Tests: none
    boolean false Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. -
    Tests: customLabel demo +
    labelsDivdocument.
    getElementById('foo')
    document.getElementById('foo')
    or
    'foo'
    nullShow data labels in an external div, rather than on the graph. -
    Tests: demo label-div +
    Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id. +
    Tests: label-div
    +
    labelsShowZeroValuesbooleantrueShow zero value labels in the labelsDiv. +
    Tests: label-div
    true false Show K/M/B for thousands/millions/billions on y-axis. -
    Tests: demo labelsKMB no-range +
    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. -
    Tests: labelsKMB +
    Tests: labelsKMB
    250 Width (in pixels) of the div which shows information on the currently-highlighted points. -
    Tests: customLabel +
    Tests: customLabel
    {} null Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold. -
    Tests: border customLabel +
    integer 3 The size in pixels of the dot drawn over highlighted points. -
    Tests: grid_dot +
    Tests: grid_dot
    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. -
    Tests: draw-points +
    Tests: draw-points
    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. -
    Tests: none +
    Tests: none
    integer 60 Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks. -
    Tests: spacing +
    Tests: spacing
    integer Width (in pixels) of the x- and y-axis labels. -
    Tests: customLabel +
    Tests: customLabel
    integer 14 Size of the font (in pixels) to use in the axis labels, both x- and y-axis. -
    Tests: none +
    Tests: none
    xAxisLabelFormatterfunction(date, granularity)Dygraph.dateAxisFormatterFunction to call to format values along the x axis. + +
    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. -
    Tests: none +
    Tests: none
    boolean false Does the data contain standard deviations? Setting this to true alters the input format (see above). -
    Tests: noise customLabel draw-points fillGraph fractions +
    integer When errorBars is set, shade this many standard deviations above/below each point. -
    Tests: none +
    Tests: none
    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). -
    Tests: fractions +
    Tests: fractions
    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. -
    Tests: none +
    Tests: none
    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. -
    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. + +
    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}, … ] + +
    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. + +
    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. +
    height320
    @@ -762,6 +838,26 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
  • Make sure you don't have any trailing commas in your call to the Dygraph constructor or in the options parameter. Firefox, Chrome and Safari ignore these but they can cause a graph to not display in Internet Explorer.
  • +

    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 dataTable, 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.