* MIT-licensed (http://opensource.org/licenses/MIT)
*/
-/*jshint globalstrict: true */
-/*global Dygraph:false */
-
// NOTE: in addition to parsing as JS, this snippet is expected to be valid
// JSON. This assumption cannot be checked in JS, but it will be checked when
// documentation is generated by the generate-documentation.py script. For the
"default": "false",
"labels": ["Data Line display"],
"type": "boolean",
- "description": "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."
+ "description": "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."
+ },
+ "stackedGraphNaNFill": {
+ "default": "all",
+ "labels": ["Data Line display"],
+ "type": "string",
+ "description": "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)."
},
"pointSize": {
"default": "1",
[ "cx" , "center x coordinate" ],
[ "cy" , "center y coordinate" ],
[ "color" , "series color" ],
- [ "pointSize" , "the radius of the image." ]
+ [ "pointSize" , "the radius of the image." ],
+ [ "idx" , "the row-index of the point in the data."]
],
"description": "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 <a href='#drawHighlightPointCallback'>drawHighlightPointCallback</a>"
},
],
"description": "A function to call when a data point is clicked. and the point that was clicked."
},
+ "color": {
+ "default": "(see description)",
+ "labels": ["Data Series Colors"],
+ "type": "string",
+ "example": "red",
+ "description": "A per-series color definition. Used in conjunction with, and overrides, the colors option."
+ },
"colors": {
"default": "(see description)",
"labels": ["Data Series Colors"],
"type": "array<string>",
"example": "['red', '#00FF00']",
- "description": "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."
+ "description": "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."
},
"connectSeparatedPoints": {
"default": "false",
[ "cx" , "center x coordinate" ],
[ "cy" , "center y coordinate" ],
[ "color" , "series color" ],
- [ "pointSize" , "the radius of the image." ]
+ [ "pointSize" , "the radius of the image." ],
+ [ "idx" , "the row-index of the point in the data."]
],
"description": "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 <a href='#drawPointCallback'>drawPointCallback</a>"
},
"underlayCallback": {
"default": "null",
"labels": ["Callbacks"],
- "type": "function(canvas, area, dygraph)",
+ "type": "function(context, area, dygraph)",
"parameters": [
- [ "canvas" , "the canvas to draw on" ],
- [ "area" , "" ],
+ [ "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" ]
],
"description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
"description": "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 <a href='per-axis.html'>per-axis</a> basis."
},
"xAxisLabelWidth": {
- "default": "50",
- "labels": ["Axis display"],
+ "default": "",
+ "labels": ["Deprecated"],
"type": "integer",
- "description": "Width, in pixels, of the x-axis labels."
+ "description": "Prefer axes: { x: { axisLabelWidth } }"
},
"xAxisHeight": {
"default": "(null)",
"axis": {
"default": "(none)",
"labels": ["Axis display"],
- "type": "string or object",
- "description": "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."
+ "type": "string",
+ "description": "Set to either 'y1' or 'y2' to assign a series to a y-axis (primary or secondary). Must be set per-series."
},
"pixelsPerXLabel": {
"default": "",
"description": "Prefer axes { x: { pixelsPerLabel } }"
},
"pixelsPerLabel": {
- "default": "60 (x-axis) or 30 (y-axes)",
+ "default": "70 (x-axis) or 30 (y-axes)",
"labels": ["Axis display", "Grid"],
"type": "integer",
"description": "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 <a href='per-axis.html'>per-axis</a> basis."
"default": "false",
"labels": ["Axis display"],
"type": "boolean",
- "description": "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.\n\nNot compatible with showZero, and ignores connectSeparatedPoints. Also, showing log scale with valueRanges that are less than zero will result in an unviewable graph."
+ "description": "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.\n\n Not compatible with showZero. connectSeparatedPoints is ignored. This is ignored for date-based x-axes."
},
"strokeWidth": {
"default": "1.0",
"default": "rgb(128,128,128)",
"labels": ["Grid"],
"type": "red, blue",
- "description": "The color of the gridlines."
+ "description": "The color of the gridlines. This may be set on a per-axis basis to define each axis' grid separately."
+ },
+ "gridLinePattern": {
+ "default": "null",
+ "labels": ["Grid"],
+ "type": "array<integer>",
+ "example": "[10, 2, 5, 2]",
+ "description": "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."
},
"visibility": {
"default": "[true, true, ...]",
"labels": ["Axis display"],
"type": "Array of two numbers",
"example": "[10, 110]",
- "description": "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."
+ "description": "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)"
},
"labelsDivWidth": {
"default": "250",
"description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
},
"yAxisLabelWidth": {
- "default": "50",
- "labels": ["Axis display"],
+ "default": "",
+ "labels": ["Deprecated"],
"type": "integer",
- "description": "Width, in pixels, of the y-axis labels. This also affects the amount of space available for a y-axis chart label."
+ "description": "Prefer axes { y: { axisLabelWidth } }"
},
"hideOverlayOnMouseOut": {
"default": "true",
"default": "onmouseover",
"labels": ["Legend"],
"type": "string",
- "description": "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."
+ "description": "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."
},
"labelsShowZeroValues": {
"default": "true",
"default": "false",
"labels": ["Data Line display"],
"type": "boolean",
- "description": "When set, display the graph as a step plot instead of a line plot."
+ "description": "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."
+ },
+ "labelsUTC": {
+ "default": "false",
+ "labels": ["Value display/formatting", "Axis display"],
+ "type": "boolean",
+ "description": "Show date/time labels according to UTC (instead of local time)."
},
"labelsKMB": {
"default": "false",
},
"avoidMinZero": {
"default": "false",
- "labels": ["Axis display"],
+ "labels": ["Deprecated"],
"type": "boolean",
- "description": "When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value 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."
+ "description": "Deprecated, please use yRangePad instead. When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value 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."
},
"drawAxesAtZero": {
"default": "false",
"type": "boolean",
"description": "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."
},
+ "xRangePad": {
+ "default": "0",
+ "labels": ["Axis display"],
+ "type": "float",
+ "description": "Add the specified amount of extra space (in pixels) around the X-axis value range to ensure points at the edges remain visible."
+ },
+ "yRangePad": {
+ "default": "null",
+ "labels": ["Axis display"],
+ "type": "float",
+ "description": "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."
+ },
"xAxisLabelFormatter": {
"default": "",
"labels": ["Deprecated"],
"dateWindow": {
"default": "Full range of the input is shown",
"labels": ["Axis display"],
- "type": "Array of two Dates or numbers",
+ "type": "Array of two numbers",
"example": "[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]",
"description": "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."
},
},
"drawXGrid": {
"default": "true",
- "labels": ["Grid"],
+ "labels": ["Grid","Deprecated"],
"type": "boolean",
- "description" : "Whether to display vertical gridlines under the chart."
+ "description" : "Use the per-axis option drawGrid instead. Whether to display vertical gridlines under the chart."
},
"drawYGrid": {
"default": "true",
+ "labels": ["Grid","Deprecated"],
+ "type": "boolean",
+ "description" : "Use the per-axis option drawGrid instead. Whether to display horizontal gridlines under the chart."
+ },
+ "drawGrid": {
+ "default": "true for x and y, false for y2",
"labels": ["Grid"],
"type": "boolean",
- "description" : "Whether to display horizontal gridlines under the chart."
+ "description" : "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."
+ },
+ "independentTicks": {
+ "default": "true for y, false for y2",
+ "labels": ["Axis display", "Grid"],
+ "type": "boolean",
+ "description" : "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."
},
"drawXAxis": {
"default": "true",
"labels": ["Axis display"],
"type": "boolean",
- "description" : "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."
+ "description" : "Deprecated. Use axes : { x : { drawAxis } }."
},
"drawYAxis": {
"default": "true",
"labels": ["Axis display"],
"type": "boolean",
- "description" : "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."
+ "description" : "Deprecated. Use axes : { y : { drawAxis } }."
+ },
+ "drawAxis": {
+ "default": "true for x and y, false for y2",
+ "labels": ["Axis display"],
+ "type": "boolean",
+ "description" : "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."
},
"gridLineWidth": {
"default": "0.3",
"labels": ["Grid"],
"type": "float",
- "description" : "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."
+ "description" : "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. This may be set on a per-axis basis to define each axis' grid separately."
},
"axisLineWidth": {
"default": "0.3",
"description" : "Color for x- and y-axis labels. This is a CSS color string."
},
"axisLabelWidth": {
- "default": "50",
+ "default": "50 (y-axis), 60 (x-axis)",
"labels": ["Axis display", "Chart labels"],
"type": "integer",
- "description" : "Width (in pixels) of the containing divs for x- and y-axis labels. For the y-axis, this also controls "
+ "description" : "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."
},
"sigFigs" : {
"default": "null",
"default": "false",
"labels": ["Interactive Elements"],
"type": "boolean",
- "description": "Show the range selector widget. This option can only be specified at Dygraph creation time."
+ "description": "Show or hide the range selector widget."
},
"rangeSelectorHeight": {
"default": "40",
"type": "string",
"description": "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."
},
+ "showInRangeSelector": {
+ "default": "null",
+ "labels": ["Interactive Elements"],
+ "type": "boolean",
+ "description": "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 series. Setting it for one series will result in that series being charted alone in the range selector."
+ },
"animatedZooms": {
"default": "false",
"labels": ["Interactive Elements"],
"labels": ["Data Line display"],
"type": "array or function",
"description": "A function (or array of functions) which plot each data series on the chart. TODO(danvk): more details! May be set per-series."
- }
+ },
+ "axes": {
+ "default": "null",
+ "labels": ["Configuration"],
+ "type": "Object",
+ "description": "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 <a href='http://dygraphs.com/per-axis.html'>per-series and per-axis options</a>."
+ },
"series": {
"default": "null",
"labels": ["Series"],
- "type": "Object"
- "description": "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. When this option is missing, it falls back on the old-style of per-series options comingled with global options."
+ "type": "Object",
+ "description": "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."
+ },
+ "plugins": {
+ "default": "[]",
+ "labels": ["Configuration"],
+ "type": "Array<plugin>",
+ "description": "Defines per-graph plugins. Useful for per-graph customization"
+ },
+ "dataHandler": {
+ "default": "(depends on data)",
+ "labels": ["Data"],
+ "type": "Dygraph.DataHandler",
+ "description": "Custom DataHandler. This is an advanced customization. See http://bit.ly/151E7Aq."
}
}
; // </JSON>
// Do a quick sanity check on the options reference.
(function() {
"use strict";
- var warn = function(msg) { if (console) console.warn(msg); };
+ var warn = function(msg) { if (window.console) window.console.warn(msg); };
var flds = ['type', 'default', 'description'];
var valid_cats = [
'Annotations',
'Legend',
'Overall display',
'Rolling Averages',
+ 'Series',
'Value display/formatting',
'Zooming',
'Debugging',
+ 'Configuration',
'Deprecated'
];
var i;
projects / dygraphs.git / blobdiff