X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=dygraph-options-reference.js;h=9d4a4857690fa5ebdab425b4478d50bf3acdd214;hb=34ad56b341279a066dc8bad129501d8d254699c1;hp=abdb0156d997d7dae4775a60d2f9afc9b372e10d;hpb=cf8c87d4c4d46946071c30453bdcedcb1dd8f9d7;p=dygraphs.git diff --git a/dygraph-options-reference.js b/dygraph-options-reference.js index abdb015..9d4a485 100644 --- a/dygraph-options-reference.js +++ b/dygraph-options-reference.js @@ -269,10 +269,10 @@ Dygraph.OPTIONS_REFERENCE = // "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." @@ -421,7 +421,7 @@ Dygraph.OPTIONS_REFERENCE = // "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", @@ -469,7 +469,7 @@ Dygraph.OPTIONS_REFERENCE = // "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." }, "labelsKMB": { "default": "false", @@ -728,7 +728,7 @@ Dygraph.OPTIONS_REFERENCE = // "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", @@ -759,6 +759,18 @@ Dygraph.OPTIONS_REFERENCE = // "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." + }, + "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." + }, + "plugins": { + "default": "[]", + "labels": ["Configuration"], + "type": "Array", + "description": "Defines per-graph plug-ins. Useful for per-graph customization" } } ; // @@ -770,7 +782,7 @@ Dygraph.OPTIONS_REFERENCE = // // 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', @@ -787,9 +799,11 @@ Dygraph.OPTIONS_REFERENCE = // 'Legend', 'Overall display', 'Rolling Averages', + 'Series', 'Value display/formatting', 'Zooming', 'Debugging', + 'Configuration', 'Deprecated' ]; var i;