dygraphs

<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> <style> .KEYW {color: #933;} .COMM {color: #bbb; font-style: italic;} .NUMB {color: #393;} .STRN {color: #393;} .REGX {color: #339;} .line {border-right: 1px dotted #666; color: #666; font-style: normal;} </style></head><body><pre> 1 /** 2 * @license 3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com) 4 * MIT-licenced: https://opensource.org/licenses/MIT 5 */ 6 7 "use strict"; 8 9 var OPTIONS_REFERENCE = null; 10 11 if (typeof process !== 'undefined' && process.env.NODE_ENV != 'production') { 12 // For "production" code, this gets removed by uglifyjs. 13 14 // NOTE: in addition to parsing as JS, this snippet is expected to be valid 15 // JSON. This assumption cannot be checked in JS, but it will be checked when 16 // documentation is generated by the generate-documentation.py script. For the 17 // most part, this just means that you should always use double quotes. 18 OPTIONS_REFERENCE = // <JSON> 19 { 20 "animateBackgroundFade": { 21 "default": "true", 22 "labels": ["Overall display"], 23 "type": "boolean", 24 "description": "Activate an animation effect for a gradual fade." 25 }, 26 "xValueParser": { 27 "default": "parseFloat() or Date.parse()*", 28 "labels": ["CSV parsing"], 29 "type": "function(str) -> number", 30 "description": "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." 31 }, 32 "stackedGraph": { 33 "default": "false", 34 "labels": ["Data Line display"], 35 "type": "boolean", 36 "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." 37 }, 38 "stackedGraphNaNFill": { 39 "default": "all", 40 "labels": ["Data Line display"], 41 "type": "string", 42 "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)." 43 }, 44 "pointSize": { 45 "default": "1", 46 "labels": ["Data Line display"], 47 "type": "integer", 48 "description": "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." 49 }, 50 "drawPoints": { 51 "default": "false", 52 "labels": ["Data Line display"], 53 "type": "boolean", 54 "description": "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 <a href='#drawPointCallback'>drawPointCallback</a>." 55 }, 56 "drawGapEdgePoints": { 57 "default": "false", 58 "labels": ["Data Line display"], 59 "type": "boolean", 60 "description": "Draw points at the edges of gaps in the data. This improves visibility of small data segments or other data irregularities." 61 }, 62 "drawPointCallback": { 63 "default": "null", 64 "labels": ["Data Line display"], 65 "type": "function(g, seriesName, canvasContext, cx, cy, color, pointSize, idx)", 66 "parameters": [ 67 ["g", "the reference graph"], 68 ["seriesName", "the name of the series"], 69 ["canvasContext", "the canvas to draw on"], 70 ["cx", "center x coordinate"], 71 ["cy", "center y coordinate"], 72 ["color", "series color"], 73 ["pointSize", "the radius of the image."], 74 ["idx", "the row-index of the point in the data."] 75 ], 76 "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>" 77 }, 78 "height": { 79 "default": "320", 80 "labels": ["Overall display"], 81 "type": "integer", 82 "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored." 83 }, 84 "resizable": { 85 "default": "no", 86 "labels": ["Overall display"], 87 "type": "string", 88 "description": "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." 89 }, 90 "zoomCallback": { 91 "default": "null", 92 "labels": ["Callbacks"], 93 "type": "function(minDate, maxDate, yRanges)", 94 "parameters": [ 95 ["minDate", "milliseconds since epoch"], 96 ["maxDate", "milliseconds since epoch."], 97 ["yRanges", "is an array of [bottom, top] pairs, one for each y-axis."] 98 ], 99 "description": "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)." 100 }, 101 "pointClickCallback": { 102 "snippet": "function(e, point){ alert(point); }", 103 "default": "null", 104 "labels": ["Callbacks", "Interactive Elements"], 105 "type": "function(e, point)", 106 "parameters": [ 107 ["e", "the event object for the click"], 108 ["point", "the point that was clicked See <a href='#point_properties'>Point properties</a> for details"] 109 ], 110 "description": "A function to call when a data point is clicked. and the point that was clicked." 111 }, 112 "color": { 113 "default": "(see description)", 114 "labels": ["Data Series Colors"], 115 "type": "string", 116 "example": "red", 117 "description": "A per-series color definition. Used in conjunction with, and overrides, the colors option." 118 }, 119 "colors": { 120 "default": "(see description)", 121 "labels": ["Data Series Colors"], 122 "type": "Array of strings", 123 "example": "['red', '#00FF00']", 124 "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." 125 }, 126 "connectSeparatedPoints": { 127 "default": "false", 128 "labels": ["Data Line display"], 129 "type": "boolean", 130 "description": "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." 131 }, 132 "highlightCallback": { 133 "default": "null", 134 "labels": ["Callbacks"], 135 "type": "function(event, x, points, row, seriesName)", 136 "description": "When set, this callback gets called every time a new point is highlighted.", 137 "parameters": [ 138 ["event", "the JavaScript mousemove event"], 139 ["x", "the x-coordinate of the highlighted points"], 140 ["points", "an array of highlighted points: <code>[ {name: 'series', yval: y-value}, … ]</code>"], 141 ["row", "integer index of the highlighted row in the data table, starting from 0"], 142 ["seriesName", "name of the highlighted series, only present if highlightSeriesOpts is set."] 143 ] 144 }, 145 "drawHighlightPointCallback": { 146 "default": "null", 147 "labels": ["Data Line display"], 148 "type": "function(g, seriesName, canvasContext, cx, cy, color, pointSize, idx)", 149 "parameters": [ 150 ["g", "the reference graph"], 151 ["seriesName", "the name of the series"], 152 ["canvasContext", "the canvas to draw on"], 153 ["cx", "center x coordinate"], 154 ["cy", "center y coordinate"], 155 ["color", "series color"], 156 ["pointSize", "the radius of the image."], 157 ["idx", "the row-index of the point in the data."] 158 ], 159 "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>" 160 }, 161 "highlightSeriesOpts": { 162 "default": "null", 163 "labels": ["Interactive Elements"], 164 "type": "Object", 165 "description": "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 }." 166 }, 167 "highlightSeriesBackgroundAlpha": { 168 "default": "0.5", 169 "labels": ["Interactive Elements"], 170 "type": "float", 171 "description": "Fade the background while highlighting series. 1=fully visible background (disable fading), 0=hiddden background (show highlighted series only)." 172 }, 173 "highlightSeriesBackgroundColor": { 174 "default": "rgb(255, 255, 255)", 175 "labels": ["Interactive Elements"], 176 "type": "string", 177 "description": "Sets the background color used to fade out the series in conjunction with “highlightSeriesBackgroundAlpha”." 178 }, 179 "includeZero": { 180 "default": "false", 181 "labels": ["Axis display"], 182 "type": "boolean", 183 "description": "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" 184 }, 185 "rollPeriod": { 186 "default": "1", 187 "labels": ["Error Bars", "Rolling Averages"], 188 "type": "integer >= 1", 189 "description": "Number of days over which to average data. Discussed extensively above." 190 }, 191 "unhighlightCallback": { 192 "default": "null", 193 "labels": ["Callbacks"], 194 "type": "function(event)", 195 "parameters": [ 196 ["event", "the mouse event"] 197 ], 198 "description": "When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph." 199 }, 200 "axisTickSize":