default: 480
desc: Width, in pixels, of the chart. If the container div has been explicitly sized, this will be
ignored.
- category: Overall display
tags:
- overall display
default: 320
desc: Height, in pixels, of the chart. If the container div has been explicitly sized, this will be
ignored.
- category: Overall display
tags:
- overall display
+- name: file
+ type: String (URL of CSV or CSV), GViz DataTable or 2D Array
+ default: null
+ desc: Sets the data being displayed in the chart. This can only be set when calling updateOptions;
+ it cannot be set from the constructor. For a full description of valid data formats, see the Data
+ Formats page.
+ tags:
+ - data
+ examples:
+ - drawing
+ - dygraph-many-points-benchmark
+
- name: annotationClickHandler
type: function(annotation, point, dygraph, event)
default: null
desc: If provided, this function is called whenever the user clicks on an annotation.
- category: Annotations
tags:
- annotations
- handler
type: function(annotation, point, dygraph, event)
default: null
desc: If provided, this function is called whenever the user double-clicks on an annotation.
- category: Annotations
tags:
- annotations
- handler
type: function(annotation, point, dygraph, event)
default: null
desc: If provided, this function is called whenever the user mouses out of an annotation.
- category: Annotations
tags:
- annotations
- handler
type: function(annotation, point, dygraph, event)
default: null
desc: If provided, this function is called whenever the user mouses over an annotation.
- category: Annotations
tags:
- annotations
- handler
desc: Only applies when Dygraphs is used as a GViz chart. Causes string columns following a data series
to be interpreted as annotations on points in that series. This is the same format used by Google's
AnnotatedTimeLine chart.
- category: Annotations
tags:
- annotations
examples:
\ of zero is disabled. \nThis is particularly useful for data sets that contain many zero values,\
\ especially for step plots which may otherwise have lines not visible running along the bottom\
\ axis."
- category: Axes
tags:
- axes
examples:
default: null
desc: Set to either an object ({}) filled with options for this axis or to the name of an existing
data series with its own axis to re-use that axis. See tests for usage.
- category: Axes
tags:
- axes
examples:
type: String
default: black
desc: Color for x- and y-axis labels. This is a CSS color string.
- category: Axes
tags:
- axes
type: Integer
default: 14
desc: Size of the font (in pixels) to use in the axis labels, both x- and y-axis.
- category: Axes
tags:
- axes
(for a date axis). The second argument specifies how fine-grained the axis is. For date axes,
this is a reference to the time granularity enumeration, defined in dygraph-tickers.js, e.g. Dygraph.WEEKLY.
opts is a function which provides access to various options on the dygraph, e.g. opts('labelsKMB').
- category: Axes
tags:
- axes
examples:
default: 50
desc: Width (in pixels) of the containing divs for x- and y-axis labels. For the y-axis, this also
controls
- category: Axes
tags:
- axes
- labels
default: black
desc: Color of the x- and y-axis lines. Accepts any value which the HTML canvas strokeStyle attribute
understands, e.g. 'black' or 'rgb(0, 100, 255)'.
- category: Axes
tags:
- axes
examples:
type: Float
default: 0.3
desc: Thickness (in pixels) of the x- and y-axis lines.
- category: Axes
tags:
- axes
type: Number
default: '3.0'
desc: The size of the line to display next to each tick mark on x- or y-axes.
- category: Axes
tags:
- axes
desc: Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest
are milliseconds since epoch. If the data for the x-axis is numeric, the values in dateWindow
must also be numbers. By default, the full range of the input is shown.
- category: Axes
tags:
- axes
examples:
default: true
desc: Whether to draw the x-axis. Setting this to false also prevents x-axis ticks from being drawn
and reclaims the space for the chart grid/lines.
- category: Axes
tags:
- axes
examples:
default: true
desc: Whether to draw the y-axis. Setting this to false also prevents y-axis ticks from being drawn
and reclaims the space for the chart grid/lines.
- category: Axes
tags:
- axes
examples:
desc: 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
- category: Axes
tags:
- axes
examples:
desc: When set for a y-axis, the graph shows that axis in log scale. Any values less than or equal
to zero are not displayed. Not compatible with showZero, and ignores connectSeparatedPoints.
Also, showing log scale with valueRanges that are less than zero will result in an unviewable graph.
- category: Axes
tags:
- axes
examples:
desc: A value representing the farthest a graph may be panned, in percent of the display. For example,
a value of 0.1 means that the graph can only be panned 10% pased the edges of the displayed values.
null means no bounds.
- category: Axes
tags:
- axes
- interactive elements
default: null
desc: Number of pixels to require between each x- and y-label. Larger values will yield a sparser
axis with fewer ticks. This is set on a per-axis basis. By default, values are 60 (x-axis) or 30 (y-axes).
- category: Axes
tags:
- axes
- grid
tick marks so, if you set this option, you'll most likely want to call one of them and modify
the result. By default, uses Dygraph.dateTicker or Dygraph.numericTicks, but see
dygraph-tickers.js for an extensive discussion. This is set on a per-axis basis.
- category: Axes
tags:
- axes
default: null
desc: Explicitly set the vertical range of the graph to [low, high]. This may be set on a per-axis
basis to define each y-axis separately. By default, the full range of the input is shown.
- category: Axes
tags:
- axes
examples:
default: null
desc: Height, in pixels, of the x-axis. If not set explicitly, this is computed based on axisLabelFontSize
and axisTickSize.
- category: Axes
tags:
- axes
type: Integer
default: 50
desc: Width, in pixels, of the x-axis labels.
- category: Axes
tags:
- axes
examples:
default: 50
desc: Width, in pixels, of the y-axis labels. This also affects the amount of space available for
a y-axis chart label.
- category: Axes
tags:
- axes
examples:
default: ','
desc: The delimiter to look for when separating fields of a CSV file. Setting this to a tab is not
usually necessary, since tab-delimited data is auto-detected.
- category: CSV parsing
tags:
- csv parsing
* Dygraphs is slightly more accepting in the dates which it will parse. See code for
details.
- category: CSV parsing
tags:
- csv parsing
\ data coordinates of the point (with dates/times as millis since epoch) \n * canvasx/canvasy:\
\ The canvas coordinates at which the point is drawn. \n name: The name of the data series to\
\ which the point belongs"
- category: Callbacks
tags:
- callbacks
examples:
desc: When 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.
- category: Callbacks
tags:
- callbacks
examples:
desc: 'When 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}, ... ]'
- category: Callbacks
tags:
- callbacks
examples:
type: function(canvas, area, dygraph)
default: null
desc: When set, this callback gets called before the chart is drawn. It details on how to use this.
- category: Callbacks
tags:
- callbacks
examples:
default: null
desc: When 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.
- category: Callbacks
tags:
- callbacks
examples:
desc: A function to call when the zoom window is changed (either by zooming in or out). minDate and
maxDate are milliseconds since epoch. yRanges is an array of [bottom, top] pairs, one for each
y-axis.
- category: Callbacks
tags:
- callbacks
examples:
default: null
desc: Text to display above the chart. You can supply any HTML for this value, not just text. If you
wish to style it using CSS, use the 'dygraph-label' or 'dygraph-title' classes.
- category: Chart labels
tags:
- chart labels
examples:
desc: Height of the chart title, in pixels. This also controls the default font size of the title.
If you style the title on your own, this controls how much space is set aside above the chart
for the title's div.
- category: Chart labels
tags:
- chart labels
examples:
desc: Height of the x-axis label, in pixels. This also controls the default font size of the x-axis
label. If you style the label on your own, this controls how much space is set aside below the
chart for the x-axis label's div.
- category: Chart labels
tags:
- chart labels
default: null
desc: Text to display below the chart's x-axis. You can supply any HTML for this value, not just text.
If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-xlabel' classes.
- category: Chart labels
tags:
- chart labels
examples:
a secondary y-axis is present. See this test for an example of how to do this. The comments for
the 'ylabel' option generally apply here as well. This label gets a 'dygraph-y2label' instead
of a 'dygraph-ylabel' class.
- category: Chart labels
tags:
- chart labels
examples:
default: 18
desc: Width of the div which contains the y-axis label. Since the y-axis label appears rotated 90
degrees, this actually affects the height of its div.
- category: Chart labels
tags:
- chart labels
the y-axis tick labels using the yAxisLabelWidth option. If you need a wider div for the y-axis
label, either style it that way with CSS (but remember that it's rotated, so width is controlled
by the 'height' property) or set the yLabelWidth option.
- category: Chart labels
tags:
- chart labels
examples:
- temperature-sf-ny
- two-axes-vr
-- name: file
- type: String (URL of CSV or CSV), GViz DataTable or 2D Array
- default: null
- desc: Sets the data being displayed in the chart. This can only be set when calling updateOptions;
- it cannot be set from the constructor. For a full description of valid data formats, see the Data
- Formats page.
- category: Data
- tags:
- - data
- examples:
- - drawing
- - dygraph-many-points-benchmark
-
- name: connectSeparatedPoints
type: Boolean
default: false
gap and draws it as such. If, instead, the missing values represents an x-value for which only
a different series has data, then you'll want to connect the dots by setting this to true. To
explicitly include a gap with this option set, use a value of NaN.
- category: Data Line display
tags:
- data line display
examples:
default: false
desc: 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.
- category: Data Line display
tags:
- data line display
examples:
type: Boolean
default: false
desc: Should the area underneath the graph be filled? This option is not compatible with error bars.
- category: Data Line display
tags:
- data line display
examples:
desc: 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.
- category: Data Line display
tags:
- data line display
examples:
type: Boolean
default: false
desc: If set, stack series on top of one another rather than drawing them independently.
- category: Data Line display
tags:
- data line display
examples:
type: Boolean
default: false
desc: When set, display the graph as a step plot instead of a line plot.
- category: Data Line display
tags:
- data line display
examples:
desc: 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.
- category: Data Line display
tags:
- data line display
examples:
default: 1
desc: The width of the lines connecting data points. This can be used to increase the contrast or
some graphs.
- category: Data Line display
tags:
- data line display
examples:
default: true
desc: 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.
- category: Data Line display
tags:
- data line display
examples:
type: Float (0.0 - 1.0)
default: 1.0
desc: If colors is not specified, saturation of the automatically-generated data series colors.
- category: Data Series Colors
tags:
- data series colors
default: 1.0
desc: If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0,
default 0.5)
- category: Data Series Colors
tags:
- data series colors
default: null
desc: 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.
- category: Data Series Colors
tags:
- data series colors
examples:
partial transparency. This sets the transparency. A value of 0.0 means that the error bars will
not be drawn, whereas a value of 1.0 means that the error bars will be as dark as the line for
the series itself. This can be used to produce chart lines whose thickness varies at each point.
- category: Data Series Colors
tags:
- data series colors
- error bars
default: null
desc: Set this option to log timing information. The value of the option will be logged along with
the timimg, so that you can distinguish multiple dygraphs on the same page.
- category: Debugging
tags:
- debugging
examples:
default: null
desc: 'Prefer axes { x: { pixelsPerLabel } }'
hidden: true
- category: Deprecated
tags:
- deprecated
default: null
desc: 'Prefer axes: { y: { pixelsPerLabel } }'
hidden: true
- category: Deprecated
tags:
- deprecated
examples:
default: null
desc: 'Prefer axes { x: { axisLabelFormatter } }'
hidden: true
- category: Deprecated
tags:
- deprecated
default: null
desc: 'Prefer axes: { x: { valueFormatter } }'
hidden: true
- category: Deprecated
tags:
- deprecated
default: null
desc: 'Prefer axes: { y: { axisLabelFormatter } }'
hidden: true
- category: Deprecated
tags:
- deprecated
default: null
desc: 'Prefer axes: { y: { valueFormatter } }'
hidden: true
- category: Deprecated
tags:
- deprecated
examples:
default: false
desc: 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.
- category: Error Bars
tags:
- - error bar
+ - error bars
- bars
- csv
- parsing
default: false
desc: Does the data contain standard deviations? Setting this to true alters the input format (see
above).
- category: Error Bars
tags:
- error bars
- bars
default: false
desc: 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).
- category: Error Bars
tags:
- error bars
- bars
type: Float
default: 2.0
desc: When errorBars is set, shade this many standard deviations above/below each point.
- category: Error Bars
tags:
- error bars
desc: 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.
- category: Error Bars
tags:
- error bars
type: Boolean
default: true
desc: Whether to display vertical gridlines under the chart.
- category: Grid
tags:
- grid
examples:
type: Boolean
default: true
desc: Whether to display horizontal gridlines under the chart.
- category: Grid
tags:
- grid
examples:
type: String
default: rgb(128,128,128)
desc: The color of the gridlines. This can be of the form "#AABBCC" or "rgb(255,100,200)" or "yellow".
- category: Grid
tags:
- grid
examples:
default: 0.3
desc: Thickness (in pixels) of the gridlines drawn under the chart. The vertical/horizontal gridlines
can be turned off entirely by using the drawXGrid and drawYGrid options.
- category: Grid
tags:
- grid
desc: Set this option to animate the transition between zoom windows. Applies to programmatic and
interactive zooms. Note that if you also set a drawCallback, it will be called several times on
each zoom. If you set a zoomCallback, it will only be called after the animation is complete.
- category: Interactive Elements
tags:
- interactive elements
examples:
type: Integer
default: 3
desc: The size in pixels of the dot drawn over highlighted points.
- category: Interactive Elements
tags:
- interactive elements
examples:
type: Object
default: null
desc: 'TODO(konigsberg): document this'
- category: Interactive Elements
tags:
- interactive elements
examples:
\ * xval/yval: The data coordinates of the point (with dates/times as millis since epoch) \n *\
\ canvasx/canvasy: The canvas coordinates at which the point is drawn. \n name: The name of the\
\ data series to which the point belongs"
- category: Interactive Elements
tags:
- interactive elements
- callback
default: 40
desc: Height, in pixels, of the range selector widget. This option can only be specified at Dygraph
creation time.
- category: Interactive Elements
tags:
- interactive elements
examples:
default: '#A7B1C4'
desc: The range selector mini plot fill color. This can be of the form "#AABBCC" or "rgb(255,100,200)"
or "yellow". You can also specify null or "" to turn off fill.
- category: Interactive Elements
tags:
- interactive elements
examples:
default: '#808FAB'
desc: The range selector mini plot stroke color. This can be of the form "#AABBCC" or "rgb(255,100,200)"
or "yellow". You can also specify null or "" to turn off stroke.
- category: Interactive Elements
tags:
- interactive elements
examples:
type: Boolean
default: false
desc: Show the range selector widget. This option can only be specified at Dygraph creation time.
- category: Interactive Elements
tags:
- interactive elements
examples:
type: Boolean
default: true
desc: Whether to hide the legend when the mouse leaves the chart area.
- category: Legend
tags:
- legend
- interactive elements
objections, this is determined by context. For raw data, this must be specified. If it is not,
default values are supplied and a warning is logged. By default, labels roughly follow
["X", "Y1", "Y2", ...]*
- category: Legend
tags:
- legend
examples:
default: null
desc: Show data labels in an external div, rather than on the graph. This value can either be a div
element or a div id.
- category: Legend
tags:
- legend
examples:
default: null
desc: 'Additional styles to apply to the currently-highlighted points div. For example, { ''font-weight'':
''bold'' } will make the labels bold.'
- category: Legend
tags:
- legend
examples:
type: Integer
default: 250
desc: Width (in pixels) of the div which shows information on the currently-highlighted points.
- category: Legend
tags:
- legend
examples:
type: Boolean
default: false
desc: Put <br/> between lines in the label string. Often used in conjunction with labelsDiv.
- category: Legend
tags:
- legend
examples:
type: Boolean
default: true
desc: Show zero value labels in the labelsDiv.
- category: Legend
tags:
- legend
examples:
default: onmouseover
desc: When to display the legend. By default, it only appears when a user mouses over the chart. Set
it to "always" to always display a legend of some sort.
- category: Legend
tags:
- legend
examples:
type: Boolean
default: true
desc: Whether to show the legend upon mouseover.
- category: Legend
tags:
- legend
- interactive elements
default: 5
desc: Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight
the right-most data point.
- category: Overall display
tags:
- overall display
type: Integer >= 1
default: 1
desc: Number of days over which to average data. Discussed extensively above.
- category: Rolling Averages
tags:
- rolling averages
- error bars
type: Boolean
default: false
desc: If the rolling average period text box should be shown.
- category: Rolling Averages
tags:
- rolling averages
- interactive elements
value of 2 you'll get '0', '0.1', '0.12', '123.45' but not '123.456' (it will be rounded to '123.46').
Numbers with absolute value less than 0.1^digitsAfterDecimal (i.e. those which would show up as
'0.00') will be displayed in scientific notation.
- category: Value display/formatting
tags:
- value display/formatting
examples:
type: Boolean
default: false
desc: Show K/M/B for thousands/millions/billions on y-axis.
- category: Value display/formatting
tags:
- value display/formatting
examples:
default: false
desc: Show k/M/G for kilo/Mega/Giga on y-axis. This is different than labelsKMB in that it uses base
2, not 10.
- category: Value display/formatting
tags:
- value display/formatting
examples:
If there are more than maxNumberWidth digits to the left of the decimal in a number, dygraphs
will switch to scientific notation, even when not operating in scientific mode. If you'd like
to see all those digits, set this to something large, like 20 or 30.
- category: Value display/formatting
tags:
- value display/formatting
examples:
If you'd prefer to have a fixed number of significant figures, set this option to that number
of sig figs. A value of 2, for instance, would cause 1 to be display as 1.0 and 1234 to be displayed
as 1.23e+3.
- category: Value display/formatting
tags:
- value display/formatting
examples:
This is usually set on a per-axis basis. For date axes, you can call new Date(millis) to get a
Date object. opts is a function you can call to access various options (e.g. opts('labelsKMB')). Default
formatter will depend on the type of your data.
- category: Value display/formatting
tags:
- value display/formatting
- legend
options, the zoom flags are not changed to reflect a zoomed state. This is primarily useful for
when the display area of a chart is changed programmatically and also where manual zooming is
allowed and use is made of the isZoomed method to determine this.
- category: Zooming
tags:
- zooming
examples:
projects / kraken-ui.git / commitdiff