DygraphOptions class

Main chart options.

For additional info you could check http://dygraphs.com/options.html.

Annotations
  • @JS()
  • @anonymous

Constructors

DygraphOptions.new({AnnotationCallbackFunc? annotationClickHandler, AnnotationCallbackFunc? annotationDblClickHandler, AnnotationCallbackFunc? annotationMouseOutHandler, AnnotationCallbackFunc? annotationMouseOverHandler, bool? displayAnnotations, String? axis, int? axisLabelFontSize, AxisLabelFormatterFunc? axisLabelFormatter, int? axisLabelWidth, String? axisLineColor, num? axisLineWidth, num? axisTickSize, List? dateWindow, bool? drawAxesAtZero, bool? drawAxis, bool? includeZero, bool? independentTicks, bool? labelsUTC, bool? logscale, double? panEdgeFraction, int? pixelsPerLabel, TickerFunc? ticker, List? valueRange, int? xAxisHeight, num? xRangePad, num? yRangePad, bool? customBars, String? delimiter, bool? errorBars, bool? fractions, XValueParserFunc? xValueParser, ClickCallbackFunc? clickCallback, DrawCallbackFunc? drawCallback, HighlightCallbackFunc? highlightCallback, PointClickCallbackFunc? pointClickCallback, UnderlayCallbackFunc? underlayCallback, GenericEventCallbackFunc? unhighlightCallback, ZoomCallbackFunc? zoomCallback, String? title, num? titleHeight, num? xLabelHeight, String? xlabel, String? y2label, num? yLabelWidth, String? ylabel, DygraphAxes? axes, List? plugins, DygraphDataHandler? dataHandler, dynamic file, bool? connectSeparatedPoints, bool? drawGapEdgePoints, DrawPointCallbackFunc? drawHighlightPointCallback, DrawPointCallbackFunc? drawPointCallback, bool? drawPoints, bool? fillGraph, dynamic plotter, num? pointSize, bool? stackedGraph, String? stackedGraphNaNFill, bool? stepPlot, String? strokeBorderColor, num? strokeBorderWidth, List? strokePattern, num? strokeWidth, List? visibility, String? color, double? colorSaturation, double? colorValue, List? colors, double? fillAlpha, String? timingName, int? rollPeriod, num? sigma, bool? wilsonInterval, bool? drawGrid, String? gridLineColor, List? gridLinePattern, num? gridLineWidth, bool? animatedZooms, bool? hideOverlayOnMouseOut, int? highlightCircleSize, num? highlightSeriesBackgroundAlpha, String? highlightSeriesBackgroundColor, DygraphOptions? highlightSeriesOpts, DygraphInteractionModel? interactionModel, bool? showLabelsOnHighlight, bool? showRoller, List? labels, dynamic labelsDiv, bool? labelsSeparateLines, bool? labelsShowZeroValues, String? legend, LegendFormatterFunc? legendFormatter, ValueFormatterFunc? valueFormatter, num? height, num? pixelRatio, num? rightGap, num? width, double? rangeSelectorAlpha, num? rangeSelectorBackgroundLineWidth, String? rangeSelectorBackgroundStrokeColor, num? rangeSelectorForegroundLineWidth, String? rangeSelectorForegroundStrokeColor, num? rangeSelectorHeight, String? rangeSelectorPlotFillColor, String? rangeSelectorPlotFillGradientColor, num? rangeSelectorPlotLineWidth, String? rangeSelectorPlotStrokeColor, bool? showInRangeSelector, bool? showRangeSelector, dynamic series, num? digitsAfterDecimal, bool? labelsKMB, bool? labelsKMG2, int? maxNumberWidth, int? sigFigs})
factory

Properties

animatedZooms ↔ bool
Set this option to animate the transition between zoom windows. Applies to programmatic and interactive zooms.
getter/setter pair
annotationClickHandler ↔ AnnotationCallbackFunc
If provided, this function is called whenever the user clicks on an annotation.
getter/setter pair
annotationDblClickHandler ↔ AnnotationCallbackFunc
If provided, this function is called whenever the user double-clicks on an annotation.
getter/setter pair
annotationMouseOutHandler ↔ AnnotationCallbackFunc
If provided, this function is called whenever the user mouses out of an annotation.
getter/setter pair
annotationMouseOverHandler ↔ AnnotationCallbackFunc
If provided, this function is called whenever the user mouses over an annotation.
getter/setter pair
axes ↔ DygraphAxes
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.
getter/setter pair
axis ↔ String
Set to either 'y1' or 'y2' to assign a series to a y-axis (primary or secondary). Must be set per-series.
getter/setter pair
axisLabelFontSize ↔ int
Size of the font (in pixels) to use in the axis labels, both x- and y-axis.
getter/setter pair
axisLabelFormatter ↔ AxisLabelFormatterFunc
Function to call to format the tick values that appear along an axis. This is usually set on a per-axis basis.
getter/setter pair
axisLabelWidth ↔ int
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.
getter/setter pair
axisLineColor ↔ String
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)'.
getter/setter pair
axisLineWidth ↔ num
Thickness (in pixels) of the x- and y-axis lines.
getter/setter pair
axisTickSize ↔ num
The size of the line to display next to each tick mark on x- or y-axes.
getter/setter pair
clickCallback ↔ ClickCallbackFunc
A function to call when the canvas is clicked.
getter/setter pair
color ↔ String
A per-series color definition. Used in conjunction with, and overrides, the colors option.
getter/setter pair
colors ↔ List
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.
getter/setter pair
colorSaturation ↔ double
If colors is not specified, saturation of the automatically-generated data series colors. Valid values are between 0.0 and 1.0.
getter/setter pair
colorValue ↔ double
If colors is not specified, value of the data series colors, as in hue/saturation/value. Valid values are between 0.0 and 1.0.
getter/setter pair
connectSeparatedPoints ↔ bool
Usually, when Dygraphs encounters a missing value in a data series, it interprets this as a gap and draws it as such.
getter/setter pair
customBars ↔ bool
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.
getter/setter pair
dataHandler ↔ DygraphDataHandler
Custom DataHandler. This is an advanced customization. See http://bit.ly/151E7Aq.
getter/setter pair
dateWindow ↔ List<num>
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.
getter/setter pair
delimiter ↔ String
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.
getter/setter pair
digitsAfterDecimal ↔ num
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 round to 123.46).
getter/setter pair
displayAnnotations ↔ bool
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.
getter/setter pair
drawAxesAtZero ↔ bool
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.
getter/setter pair
drawAxis ↔ bool
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.
getter/setter pair
drawCallback ↔ DrawCallbackFunc
When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning.
getter/setter pair
drawGapEdgePoints ↔ bool
Draw points at the edges of gaps in the data. This improves visibility of small data segments or other data irregularities.
getter/setter pair
drawGrid ↔ bool
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.
getter/setter pair
drawHighlightPointCallback ↔ DrawPointCallbackFunc
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.
getter/setter pair
drawPointCallback ↔ DrawPointCallbackFunc
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.
getter/setter pair
drawPoints ↔ bool
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.
getter/setter pair
errorBars ↔ bool
Does the data contain standard deviations? Setting this to true alters the input format.
getter/setter pair
file ↔ dynamic
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.
getter/setter pair
fillAlpha ↔ double
Error bars (or custom bars) for each series are drawn in the same color as the series, but with 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.
getter/setter pair
fillGraph ↔ bool
Should the area underneath the graph be filled? This option is not compatible with error bars. This may be set on a per-series basis.
getter/setter pair
fractions ↔ bool
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.
getter/setter pair
gridLineColor ↔ String
The color of the gridlines. This may be set on a per-axis basis to define each axis' grid separately.
getter/setter pair
gridLinePattern ↔ List
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.
getter/setter pair
gridLineWidth ↔ num
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.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ num
Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored.
getter/setter pair
hideOverlayOnMouseOut ↔ bool
Whether to hide the legend when the mouse leaves the chart area.
getter/setter pair
highlightCallback ↔ HighlightCallbackFunc
When set, this callback gets called every time a new point is highlighted.
getter/setter pair
highlightCircleSize ↔ int
The size in pixels of the dot drawn over highlighted points.
getter/setter pair
highlightSeriesBackgroundAlpha ↔ num
Fade the background while highlighting series.
getter/setter pair
highlightSeriesBackgroundColor ↔ String
Sets the background color used to fade out the series in conjunction with highlightSeriesBackgroundAlpha.
getter/setter pair
highlightSeriesOpts ↔ DygraphOptions
When set, the options from this object are applied to the timeseries closest to the mouse pointer for interactive highlighting. See also highlightCallback..
getter/setter pair
includeZero ↔ bool
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
getter/setter pair
independentTicks ↔ bool
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.
getter/setter pair
interactionModel ↔ DygraphInteractionModel
See http://dygraphs.com/gallery/#g/interaction
getter/setter pair
labels ↔ List<String>
A name for each data series, including the independent (X) series.
getter/setter pair
labelsDiv ↔ dynamic
Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id.
getter/setter pair
labelsKMB ↔ bool
Show K/M/B for thousands/millions/billions on y-axis.
getter/setter pair
labelsKMG2 ↔ bool
Show k/M/G for kilo/Mega/Giga on y-axis. This is different than labelsKMB in that it uses base 2, not 10.
getter/setter pair
labelsSeparateLines ↔ bool
Put <br/> between lines in the label string. Often used in conjunction with labelsDiv.
getter/setter pair
labelsShowZeroValues ↔ bool
Show zero value labels in the labelsDiv.
getter/setter pair
labelsUTC ↔ bool
Show date/time labels according to UTC (instead of local time).
getter/setter pair
legend ↔ String
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. When set to 'follow', legend follows highlighted points.
getter/setter pair
legendFormatter ↔ LegendFormatterFunc
Set this to supply a custom formatter for the legend.
getter/setter pair
logscale ↔ bool
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.
getter/setter pair
maxNumberWidth ↔ int
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.
getter/setter pair
panEdgeFraction ↔ double
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.
getter/setter pair
pixelRatio ↔ num
Overrides the pixel ratio scaling factor for the canvas's 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.
getter/setter pair
pixelsPerLabel ↔ int
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.
getter/setter pair
plotter ↔ dynamic
A function (or array of functions) which plot each data series on the chart.
getter/setter pair
plugins ↔ List
Defines per-graph plugins. Useful for per-graph customization
getter/setter pair
pointClickCallback ↔ PointClickCallbackFunc
A function to call when a data point is clicked. and the point that was clicked.
getter/setter pair
pointSize ↔ num
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.
getter/setter pair
rangeSelectorAlpha ↔ double
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.
getter/setter pair
rangeSelectorBackgroundLineWidth ↔ num
The width of the lines below and on both sides of the range selector mini plot.
getter/setter pair
rangeSelectorBackgroundStrokeColor ↔ String
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'.
getter/setter pair
rangeSelectorForegroundLineWidth ↔ num
The width the lines in the interactive layer of the range selector.
getter/setter pair
rangeSelectorForegroundStrokeColor ↔ String
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'.
getter/setter pair
rangeSelectorHeight ↔ num
Height, in pixels, of the range selector widget. This option can only be specified at Dygraph creation time.
getter/setter pair
rangeSelectorPlotFillColor ↔ String
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.
getter/setter pair
rangeSelectorPlotFillGradientColor ↔ String
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 'yellow'. You can also specify null or '' to disable the gradient and fill with one single color.
getter/setter pair
rangeSelectorPlotLineWidth ↔ num
The width of the range selector mini plot line.
getter/setter pair
rangeSelectorPlotStrokeColor ↔ String
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.
getter/setter pair
rightGap ↔ num
Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point.
getter/setter pair
rollPeriod ↔ int
Number of days over which to average data. Discussed extensively above.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
series ↔ dynamic
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.
getter/setter pair
showInRangeSelector ↔ bool
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).
getter/setter pair
showLabelsOnHighlight ↔ bool
Whether to show the legend upon mouseover.
getter/setter pair
showRangeSelector ↔ bool
Show or hide the range selector widget.
getter/setter pair
showRoller ↔ bool
If the rolling average period text box should be shown.
getter/setter pair
sigFigs ↔ int
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.
getter/setter pair
sigma ↔ num
When errorBars is set, shade this many standard deviations above/below each point.
getter/setter pair
stackedGraph ↔ bool
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.
getter/setter pair
stackedGraphNaNFill ↔ String
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.
getter/setter pair
stepPlot ↔ bool
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.
getter/setter pair
strokeBorderColor ↔ String
Color for the line border used if strokeBorderWidth is set.
getter/setter pair
strokeBorderWidth ↔ num
Draw a border around graph lines to make crossing lines more easily distinguishable. Useful for graphs with many lines.
getter/setter pair
strokePattern ↔ List
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.
getter/setter pair
strokeWidth ↔ num
The width of the lines connecting data points. This can be used to increase the contrast or some graphs.
getter/setter pair
ticker ↔ TickerFunc
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.
getter/setter pair
timingName ↔ String
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.
getter/setter pair
title ↔ String
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.
getter/setter pair
titleHeight ↔ num
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.
getter/setter pair
underlayCallback ↔ UnderlayCallbackFunc
When set, this callback gets called before the chart is drawn.
getter/setter pair
unhighlightCallback ↔ GenericEventCallbackFunc
When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph.
getter/setter pair
valueFormatter ↔ ValueFormatterFunc
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.
getter/setter pair
valueRange ↔ List<num>
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).
getter/setter pair
visibility ↔ List
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.
getter/setter pair
width ↔ num
Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored.
getter/setter pair
wilsonInterval ↔ bool
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.
getter/setter pair
xAxisHeight ↔ int
Height, in pixels, of the x-axis. If not set explicitly, this is computed based on axisLabelFontSize and axisTickSize.
getter/setter pair
xlabel ↔ String
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.
getter/setter pair
xLabelHeight ↔ num
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.
getter/setter pair
xRangePad ↔ num
Add the specified amount of extra space (in pixels) around the X-axis value range to ensure points at the edges remain visible.
getter/setter pair
xValueParser ↔ XValueParserFunc
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.
getter/setter pair
y2label ↔ String
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.
getter/setter pair
ylabel ↔ String
Text to display to the left of the chart's y-axis.
getter/setter pair
yLabelWidth ↔ num
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.
getter/setter pair
yRangePad ↔ num
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.
getter/setter pair
zoomCallback ↔ ZoomCallbackFunc
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).
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited