Options Reference

Dygraphs tries to do a good job of displaying your data without any further configuration. But inevitably, you’re going to want to tinker. Dygraphs provides a rich set of options for configuring its display and behaviour.

Usage

You specify options in the third parameter to the dygraphs constructor:

g = new Dygraph(div,
                data,
                {
                  option1: value1,
                  option2: value2,
                  ...
                });

After you've created a Dygraph, you can change an option by calling the updateOptions method:

g.updateOptions({
                  new_option1: value1,
                  new_option2: value2
                });

Some options can be set on a per-axis and per-series basis. See the docs on per-axis and per-series options to learn how to do this. The options which may be set in this way are marked as such on this page.

For options which are functions (e.g. callbacks and formatters), the value of this is set to the Dygraph object.

Note: tests marked with ⚠ access external resources, such as Google’s jsapi.

And, without further ado, here's the complete list of options:

Annotations

annotationClickHandler #

If provided, this function is called whenever the user clicks on an annotation.

Type: function(annotation, point, dygraph, event)

annotation:the annotation left
point:the point associated with the annotation
dygraph:the reference graph
event:the mouse event

Default: null

annotationDblClickHandler #

If provided, this function is called whenever the user double-clicks on an annotation.

Type: function(annotation, point, dygraph, event)

annotation:the annotation left
point:the point associated with the annotation
dygraph:the reference graph
event:the mouse event

Default: null

annotationMouseOutHandler #

If provided, this function is called whenever the user mouses out of an annotation.

Type: function(annotation, point, dygraph, event)

annotation:the annotation left
point:the point associated with the annotation
dygraph:the reference graph
event:the mouse event

Default: null

annotationMouseOverHandler #

If provided, this function is called whenever the user mouses over an annotation.

Type: function(annotation, point, dygraph, event)
Default: null

displayAnnotations #

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.

Type: boolean
Default: false

Axis display

axis #

Set to either 'y1' or 'y2' to assign a series to a y-axis (primary or secondary). Must be set per-series.

Type: string
Default: (none)

axisLabelFontSize #

Size of the font (in pixels) to use in the axis labels, both x- and y-axis.

Type: integer
Default: 14

axisLabelFormatter #

Function to call to format the tick values that appear along an axis. This is usually set on a per-axis basis.

Type: function(number_or_Date, granularity, opts, dygraph)

number_or_Date:Either a number (for a numeric axis) or a Date object (for a date axis)
granularity: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:a function which provides access to various options on the dygraph, e.g. opts('labelsKMB').
dygraph:the referenced graph

Default: Depends on the data type

axisLabelWidth #

Width (in pixels) of the containing divs for x- and y-axis labels. For the y-axis, this also controls the width of the y-axis. Note that for the x-axis, this is independent from pixelsPerLabel, which controls the spacing between labels.

Type: integer
Default: 50 (y-axis), 60 (x-axis)

axisLineColor #

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)'.

Type: string
Default: black

axisLineWidth #

Thickness (in pixels) of the x- and y-axis lines.

Type: float
Default: 0.3

axisTickSize #

The size of the line to display next to each tick mark on x- or y-axes.

Type: number
Default: 3.0

dateWindow #

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.

Type: Array of two numbers
Default: Full range of the input is shown

drawAxesAtZero #

When set, draw the X axis at the Y=0 position and the Y axis at the X=0 position if those positions are inside the graph’s visible area. Otherwise, draw the axes at the bottom or left graph edge as usual.

Type: boolean
Default: false

drawAxis #

Whether to draw the specified axis. This may be set on a per-axis basis to define the visibility of each axis separately. Setting this to false also prevents axis ticks from being drawn and reclaims the space for the chart grid/lines.

Type: boolean
Default: true for x and y, false for y2

includeZero #

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

Type: boolean
Default: false

independentTicks #

Only valid for y and y2, has no effect on x: This option defines whether the y axes should align their ticks or if they should be independent. Possible combinations: [1.] y=true, y2=false (default): y is the primary axis and the y2 ticks are aligned to the the ones of y. (only 1 grid) [2.] y=false, y2=true: y2 is the primary axis and the y ticks are aligned to the the ones of y2. (only 1 grid) [3.] y=true, y2=true: Both axis are independent and have their own ticks. (2 grids) [4.] y=false, y2=false: Invalid configuration causes an error.

Type: boolean
Default: true for y, false for y2

labelsUTC #

Show date/time labels according to UTC (instead of local time).

Type: boolean
Default: false

logscale #

When set for the y-axis or x-axis, the graph shows that axis in log scale. Any values less than or equal to zero are not displayed. Showing log scale with ranges that go below zero will result in an unviewable graph. Not compatible with showZero. connectSeparatedPoints is ignored. This is ignored for date-based x-axes.

Type: boolean
Default: false

panEdgeFraction #

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% passed the edges of the displayed values. null means no bounds.

Type: float
Default: null

pixelsPerLabel #

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.

Type: integer
Default: 70 (x-axis) or 30 (y-axes)

ticker #

This lets you specify an arbitrary function to generate tick marks on an axis. The tick marks are an array of (value, label) pairs. The built-in functions go to great lengths to choose good tick marks so, if you set this option, you’ll most likely want to call one of them and modify the result. See dygraph-tickers.js for an extensive discussion. This is set on a per-axis basis.

Type: function(min, max, pixels, opts, dygraph, vals) → [{v: …, label: …}, …]

min:
max:
pixels:
opts:
dygraph:the reference graph
vals:

Default: Dygraph.dateTicker or Dygraph.numericTicks

valueRange #

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. If either limit is unspecified, it will be calculated automatically (e.g. [null, 30] to automatically calculate just the lower bound)

Type: Array of two numbers
Default: Full range of the input is shown

xAxisHeight #

Height, in pixels, of the x-axis. If not set explicitly, this is computed based on axisLabelFontSize and axisTickSize.

Type: integer
Default: (null)

xRangePad #

Add the specified amount of extra space (in pixels) around the X-axis value range to ensure points at the edges remain visible.

Type: float
Default: 0

yRangePad #

If set, add the specified amount of extra space (in pixels) around the Y-axis value range to ensure points at the edges remain visible. If unset, use the traditional Y padding algorithm.

Type: float
Default: null

CSV parsing

customBars #

When set, parse each CSV cell as "low;middle;high". Custom high/low bands will be drawn for each point between low and high, with the series itself going through middle.

Type: boolean
Default: false

delimiter #

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.

Type: string
Default: ,

errorBars #

Does the data contain standard deviations? Setting this to true alters the input format (see above).

Type: boolean
Default: false

fractions #

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).

Type: boolean
Default: false

xValueParser #

A function which parses x-values (i.e. the dependent series). Must return a number, even when the values are dates. In this case, millis since epoch are used. This is used primarily for parsing CSV data. *=Dygraphs is slightly more accepting in the dates which it will parse. See code for details.

Type: function(str) -> number
Default: parseFloat() or Date.parse()*

Callbacks

clickCallback #

A function to call when the canvas is clicked.

Type: function(e, x, points)

e:The event object for the click
x:The x value that was clicked (for dates, this is milliseconds since epoch)
points:The closest points along that date. See Point properties for details.

Default: null

drawCallback #

When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning.

Type: function(dygraph, is_initial)

dygraph:The graph being drawn
is_initial:True if this is the initial draw, false for subsequent draws.

Default: null

highlightCallback #

When set, this callback gets called every time a new point is highlighted.

Type: function(event, x, points, row, seriesName)

event:the JavaScript mousemove event
x:the x-coordinate of the highlighted points
points:an array of highlighted points: [ {name: 'series', yval: y-value}, … ]
row:integer index of the highlighted row in the data table, starting from 0
seriesName:name of the highlighted series, only present if highlightSeriesOpts is set.

Default: null

pointClickCallback #

A function to call when a data point is clicked. and the point that was clicked.

Type: function(e, point)

e:the event object for the click
point:the point that was clicked See Point properties for details

Default: null

underlayCallback #

When set, this callback gets called before the chart is drawn. It details on how to use this.

Type: function(context, area, dygraph)

context:the canvas drawing context on which to draw
area:An object with {x,y,w,h} properties describing the drawing area.
dygraph:the reference graph

Default: null

unhighlightCallback #

When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph.

Type: function(event)

event:the mouse event

Default: null

zoomCallback #

A function to call when the zoom window is changed (either by zooming in or out). When animatedZooms is set, zoomCallback is called once at the end of the transition (it will not be called for intermediate frames).

Type: function(minDate, maxDate, yRanges)

minDate:milliseconds since epoch
maxDate:milliseconds since epoch.
yRanges:is an array of [bottom, top] pairs, one for each y-axis.

Default: null

Chart labels

axisLabelWidth #

Width (in pixels) of the containing divs for x- and y-axis labels. For the y-axis, this also controls the width of the y-axis. Note that for the x-axis, this is independent from pixelsPerLabel, which controls the spacing between labels.

Type: integer
Default: 50 (y-axis), 60 (x-axis)

title #

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.

Type: string
Default: null

titleHeight #

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.

Type: integer
Default: 18

xLabelHeight #

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.

Type: integer
Default: 18

xlabel #

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.

Type: string
Default: null

y2label #

Text to display to the right of the chart’s secondary y-axis. This label is only displayed if 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.

Type: string
Default: null

yLabelWidth #

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.

Type: integer
Default: 18

ylabel #

Text to display to the left of the chart’s y-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-ylabel” classes. The text will be rotated 90 degrees by default, so CSS rules may behave in unintuitive ways. No additional space is set aside for a y-axis label. If you need more space, increase the width of the y-axis tick labels using the per-axis axisLabelWidth option on the y axis. 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.

Type: string
Default: null

Configuration

axes #

Defines per-axis options. Valid keys are 'x', 'y' and 'y2'. Only some options may be set on a per-axis basis. If an option may be set in this way, it will be noted on this page. See also documentation on per-series and per-axis options.

Type: Object
Default: null

plugins #

Defines per-graph plugins. Useful for per-graph customization

Type: Array of plugins
Default: []

Data

dataHandler #

Custom DataHandler. This is an advanced customisation. See docs/datahandler-proposal.pdf.

Type: Dygraph.DataHandler
Default: (depends on data)

file #

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.

Type: string (URL of CSV or CSV), GViz DataTable or 2D Array
Default: (set when constructed)

Data Line display

connectSeparatedPoints #

Usually, when Dygraphs encounters a missing value in a data series, it interprets this as a 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.

Type: boolean
Default: false

drawGapEdgePoints #

Draw points at the edges of gaps in the data. This improves visibility of small data segments or other data irregularities.

Type: boolean
Default: false

drawHighlightPointCallback #

Draw a custom item when a point is highlighted. Default is a small dot matching the series color. This method should constrain drawing to within pointSize pixels from (cx, cy) Also see drawPointCallback

Type: function(g, seriesName, canvasContext, cx, cy, color, pointSize, idx)

g:the reference graph
seriesName:the name of the series
canvasContext:the canvas to draw on
cx:center x coordinate
cy:center y coordinate
color:series color
pointSize:the radius of the image.
idx:the row-index of the point in the data.

Default: null

drawPointCallback #

Draw a custom item when drawPoints is enabled. Default is a small dot matching the series color. This method should constrain drawing to within pointSize pixels from (cx, cy). Also see drawHighlightPointCallback

Type: function(g, seriesName, canvasContext, cx, cy, color, pointSize, idx)

g:the reference graph
seriesName:the name of the series
canvasContext:the canvas to draw on
cx:center x coordinate
cy:center y coordinate
color:series color
pointSize:the radius of the image.
idx:the row-index of the point in the data.

Default: null

drawPoints #

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. The small dot can be replaced with a custom rendering by supplying a drawPointCallback.

Type: boolean
Default: false

fillGraph #

Should the area underneath the graph be filled? This option is not compatible with customBars nor errorBars. This may be set on a per-series basis.

Type: boolean
Default: false

plotter #

A function (or array of functions) which plot each data series on the chart. TODO(danvk): more details! May be set per-series.

Type: array or function
Default: [DygraphCanvasRenderer.Plotters.fillPlotter, DygraphCanvasRenderer.Plotters.errorPlotter, DygraphCanvasRenderer.Plotters.linePlotter]

pointSize #

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.

Type: integer
Default: 1

stackedGraph #

If set, stack series on top of one another rather than drawing them independently. The first series specified in the input data will wind up on top of the chart and the last will be on bottom. NaN values are drawn as white areas without a line on top, see stackedGraphNaNFill for details.

Type: boolean
Default: false

stackedGraphNaNFill #

Controls handling of NaN values inside a stacked graph. NaN values are interpolated/extended for stacking purposes, but the actual point value remains NaN in the legend display. Valid option values are "all" (interpolate internally, repeat leftmost and rightmost value as needed), "inside" (interpolate internally only, use zero outside leftmost and rightmost value), and "none" (treat NaN as zero everywhere).

Type: string
Default: all

stepPlot #

When set, display the graph as a step plot instead of a line plot. This option may either be set for the whole graph or for single series.

Type: boolean
Default: false

strokeBorderColor #

Color for the line border used if strokeBorderWidth is set.

Type: string
Default: white

strokeBorderWidth #

Draw a border around graph lines to make crossing lines more easily distinguishable. Useful for graphs with many lines.

Type: float
Default: null

strokePattern #

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. This is used to create dashed lines.

Type: Array of integers
Default: null

strokeWidth #

The width of the lines connecting data points. This can be used to increase the contrast or some graphs.

Type: float
Default: 1.0

visibility #

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.

Type: Array of booleans
Default: [true, true, ...]

Data Series Colors

color #

A per-series color definition. Used in conjunction with, and overrides, the colors option.

Type: string
Default: (see description)

colorSaturation #

If colors is not specified, saturation of the automatically-generated data series colors.

Type: float (0.0 - 1.0)
Default: 1.0

colorValue #

If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)

Type: float (0.0 - 1.0)
Default: 1.0

colors #

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. Overridden by the “color” option.

Type: Array of strings
Default: (see description)

fillAlpha #

Custom or sigma-based high/low bands for each series are drawn in the same colour as the series, but with partial transparency. This sets the transparency. A value of 0.0 means that the bands will not be drawn, whereas a value of 1.0 means that the bands 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.

Type: float (0.0 - 1.0)
Default: 0.15

Debugging

timingName #

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.

Type: string
Default: null

Deprecated

timingName #

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.

Type: string
Default: null

Error Bars

These are actually high/low bands, not error bars; the misnomer is historic.

customBars #

When set, parse each CSV cell as "low;middle;high". Custom high/low bands will be drawn for each point between low and high, with the series itself going through middle.

Type: boolean
Default: false

errorBars #

Does the data contain standard deviations? Setting this to true alters the input format (see above).

Type: boolean
Default: false

fillAlpha #

Custom or sigma-based high/low bands for each series are drawn in the same colour as the series, but with partial transparency. This sets the transparency. A value of 0.0 means that the bands will not be drawn, whereas a value of 1.0 means that the bands 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.

Type: float (0.0 - 1.0)
Default: 0.15

fractions #

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).

Type: boolean
Default: false

sigma #

When errorBars is set, shade this many standard deviations above/below each point.

Type: float
Default: 2.0

wilsonInterval #

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.

Type: boolean
Default: true

Grid

drawGrid #

Whether to display gridlines in the chart. This may be set on a per-axis basis to define the visibility of each axis’ grid separately.

Type: boolean
Default: true for x and y, false for y2

gridLineColor #

The color of the gridlines. This may be set on a per-axis basis to define each axis’ grid separately.

Type: red, blue
Default: rgb(128,128,128)

gridLinePattern #

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. This is used to create dashed gridlines.

Type: Array of integers
Default: null

gridLineWidth #

Thickness (in pixels) of the gridlines drawn under the chart. The vertical/horizontal gridlines can be turned off entirely by using the drawGrid option. This may be set on a per-axis basis to define each axis’ grid separately.

Type: float
Default: 0.3

independentTicks #

Only valid for y and y2, has no effect on x: This option defines whether the y axes should align their ticks or if they should be independent. Possible combinations: [1.] y=true, y2=false (default): y is the primary axis and the y2 ticks are aligned to the the ones of y. (only 1 grid) [2.] y=false, y2=true: y2 is the primary axis and the y ticks are aligned to the the ones of y2. (only 1 grid) [3.] y=true, y2=true: Both axis are independent and have their own ticks. (2 grids) [4.] y=false, y2=false: Invalid configuration causes an error.

Type: boolean
Default: true for y, false for y2

pixelsPerLabel #

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.

Type: integer
Default: 70 (x-axis) or 30 (y-axes)

Interactive Elements

animatedZooms #

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.

Type: boolean
Default: false

hideOverlayOnMouseOut #

Whether to hide the legend when the mouse leaves the chart area.

Type: boolean
Default: true

highlightCircleSize #

The size in pixels of the dot drawn over highlighted points.

Type: integer
Default: 3

highlightSeriesBackgroundAlpha #

Fade the background while highlighting series. 1=fully visible background (disable fading), 0=hiddden background (show highlighted series only).

Type: float
Default: 0.5

highlightSeriesBackgroundColor #

Sets the background color used to fade out the series in conjunction with “highlightSeriesBackgroundAlpha”.

Type: string
Default: rgb(255, 255, 255)

highlightSeriesOpts #

When set, the options from this object are applied to the timeseries closest to the mouse pointer for interactive highlighting. See also “highlightCallback”. Example: highlightSeriesOpts: { strokeWidth: 3 }.

Type: Object
Default: null

interactionModel #

TODO(konigsberg): document this

Type: Object
Default: ...

panEdgeFraction #

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% passed the edges of the displayed values. null means no bounds.

Type: float
Default: null

pointClickCallback #

A function to call when a data point is clicked. and the point that was clicked.

Type: function(e, point)

e:the event object for the click
point:the point that was clicked See Point properties for details

Default: null

showLabelsOnHighlight #

Whether to show the legend upon mouseover.

Type: boolean
Default: true

showRoller #

If the rolling average period text box should be shown.

Type: boolean
Default: false

Legend

hideOverlayOnMouseOut #

Whether to hide the legend when the mouse leaves the chart area.

Type: boolean
Default: true

labels #

A distinct name for each data series, including the independent (X) series. For CSV files and DataTable objects, 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. Make sure no two names are the same!

Type: Array of strings
Default: ["X", "Y1", "Y2", ...]*

labelsDiv #

Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id.

Type: DOM element or string
Default: null

labelsSeparateLines #

Put <br/> between lines in the label string. Often used in conjunction with labelsDiv.

Type: boolean
Default: false

labelsShowZeroValues #

Show zero value labels in the labelsDiv.

Type: boolean
Default: true

legend #

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, "never" to hide it. When set to "follow", legend follows highlighted points.

Type: string
Default: onmouseover

legendFollowOffsetX #

Number of pixels to use as horizontal offset from the point for a “floating” legend ("follow" mode). This should be positive (to the right) because the legend flips over to the left side if it’s too wide.

Type: integer
Default: 50

legendFollowOffsetY #

Number of pixels to use as vertical offset from the point for a “floating” legend ("follow" mode).

Type: integer
Default: -50

legendFormatter #

Set this to supply a custom formatter for the legend. See docs/legend-formatter.md (online) and the legendFormatter demo for usage.

Type: function(data): string or DocumentFragment node
Default: null

showLabelsOnHighlight #

Whether to show the legend upon mouseover.

Type: boolean
Default: true

valueFormatter #

Function to provide a custom display format for the values displayed on mouseover. This does not affect the values that appear on tick marks next to the axes. To format those, see axisLabelFormatter. This is usually set on a per-axis basis. .

Type: function(num_or_millis, opts, seriesName, dygraph, row, col)

num_or_millis:The value to be formatted. This is always a number. For date axes, it’s millis since epoch. You can call new Date(millis) to get a Date object.
opts:This is a function you can call to access various options (e.g. opts('labelsKMB')). It returns per-axis values for the option when available.
seriesName:The name of the series from which the point came, e.g. 'X', 'Y', 'A', etc.
dygraph:The dygraph object for which the formatting is being done
row:The row of the data from which this point comes. g.getValue(row, 0) will return the x-value for this point.
col:The column of the data from which this point comes. g.getValue(row, col) will return the original y-value for this point. This can be used to get the full confidence interval for the point, or access un-rolled values for the point.

Default: Depends on the type of your data.

Overall display

animateBackgroundFade #

Activate an animation effect for a gradual fade.

Type: boolean
Default: true

height #

Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored.

Type: integer
Default: 320

pixelRatio #

Overrides the pixel ratio scaling factor for the canvas’ 2d context. Ordinarily, this is set to the devicePixelRatio / (context.backingStoreRatio || 1), so on mobile devices, where the devicePixelRatio can be somewhere around 3, performance can be improved by overriding this value to something less precise, like 1, at the expense of resolution.

Type: float
Default: (devicePixelRatio / context.backingStoreRatio)

resizable #

Whether to add a ResizeObserver to the container div ("passive") and additionally make it resizable ("horizontal", "vertical", "both"). In any case, if the container div has CSS "overflow:visible;" it will be changed to "overflow:hidden;" to make CSS resizing possible. Note that this is distinct from resizing the graph when the window size changes, which is always active; this feature adds user-resizable “handles” to the container div.

Type: string
Default: no

rightGap #

Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point.

Type: integer
Default: 5

Range Selector

rangeSelectorAlpha #

The transparency of the veil that is drawn over the unselected portions of the range selector mini plot. A value of 0 represents full transparency and the unselected portions of the mini plot will appear as normal. A value of 1 represents full opacity and the unselected portions of the mini plot will be hidden.

Type: float (0.0 - 1.0)
Default: 0.6

rangeSelectorBackgroundLineWidth #

The width of the lines below and on both sides of the range selector mini plot.

Type: float
Default: 1

rangeSelectorBackgroundStrokeColor #

The color of the lines below and on both sides of the range selector mini plot. This can be of the form "#AABBCC" or "rgb(255,100,200)" or "yellow".

Type: string
Default: gray

rangeSelectorForegroundLineWidth #

The width the lines in the interactive layer of the range selector.

Type: float
Default: 1

rangeSelectorForegroundStrokeColor #

The color of the lines in the interactive layer of the range selector. This can be of the form "#AABBCC" or "rgb(255,100,200)" or "yellow".

Type: string
Default: black

rangeSelectorHeight #

Height, in pixels, of the range selector widget. This option can only be specified at Dygraph creation time.

Type: integer
Default: 40

rangeSelectorPlotFillColor #

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.

Type: string
Default: #A7B1C4

rangeSelectorPlotFillGradientColor #

The top color for the range selector mini plot fill color gradient. This can be of the form "#AABBCC" or "rgb(255,100,200)" or "rgba(255,100,200,42)" or "yellow". You can also specify null or "" to disable the gradient and fill with one single color.

Type: string
Default: white

rangeSelectorPlotLineWidth #

The width of the range selector mini plot line.

Type: float
Default: 1.5

rangeSelectorPlotStrokeColor #

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.

Type: string
Default: #808FAB

rangeSelectorVeilColour #

The fillStyle for the veil of the range selector (e.g. "rgba(240, 240, 240, 0.6)"); if set, the rangeSelectorAlpha option is ignored.

Type: string
Default: null

showInRangeSelector #

Mark this series for inclusion in the range selector. The mini plot curve will be an average of all such series. If this is not specified for any series, the default behavior is to average all the visible series. Setting it for one series will result in that series being charted alone in the range selector. Once it’s set for a single series, it needs to be set for all series which should be included (regardless of visibility).

Type: boolean
Default: null

showRangeSelector #

Show or hide the range selector widget.

Type: boolean
Default: false

Rolling Averages

showRoller #

If the rolling average period text box should be shown.

Type: boolean
Default: false

Series

series #

Defines per-series options. Its keys match the y-axis label names, and the values are dictionaries themselves that contain options specific to that series.

Type: Object
Default: null

Value display/formatting

digitsAfterDecimal #

Unless it’s run in scientific mode (see the sigFigs option), dygraphs displays numbers with digitsAfterDecimal digits after the decimal point. Trailing zeros are not displayed, so with a 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.

Type: integer
Default: 2

labelsKMB #

Show k/M/B for thousands/millions/billions on y-axis.

Type: boolean
Default: false

labelsKMG2 #

Show Ki/Mi/Gi for powers of 1024 on y-axis. If used together with labelsKMB (deprecated), K/M/G are used instead.

Type: boolean
Default: false

labelsUTC #

Show date/time labels according to UTC (instead of local time).

Type: boolean
Default: false

maxNumberWidth #

When displaying numbers in normal (not scientific) mode, large numbers will be displayed with many trailing zeros (e.g. 100000000 instead of 1e9). This can lead to unwieldy y-axis labels. 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.

Type: integer
Default: 6

sigFigs #

By default, dygraphs displays numbers with a fixed number of digits after the decimal point. 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.

Type: integer
Default: null

valueFormatter #

Function to provide a custom display format for the values displayed on mouseover. This does not affect the values that appear on tick marks next to the axes. To format those, see axisLabelFormatter. This is usually set on a per-axis basis. .

Type: function(num_or_millis, opts, seriesName, dygraph, row, col)

num_or_millis:The value to be formatted. This is always a number. For date axes, it’s millis since epoch. You can call new Date(millis) to get a Date object.
opts:This is a function you can call to access various options (e.g. opts('labelsKMB')). It returns per-axis values for the option when available.
seriesName:The name of the series from which the point came, e.g. 'X', 'Y', 'A', etc.
dygraph:The dygraph object for which the formatting is being done
row:The row of the data from which this point comes. g.getValue(row, 0) will return the x-value for this point.
col:The column of the data from which this point comes. g.getValue(row, col) will return the original y-value for this point. This can be used to get the full confidence interval for the point, or access un-rolled values for the point.

Default: Depends on the type of your data.

Point Properties

Some callbacks take a point argument. Its properties are:
  • xval/yval: The data coordinates of the point (with dates/times as millis since epoch)
  • canvasx/canvasy: The canvas coordinates at which the point is drawn.
  • name: The name of the data series to which the point belongs
  • idx: The row number of the point in the data set