From: Dan Vanderkam <danvdk@gmail.com>
Date: Wed, 28 Oct 2015 20:22:38 +0000 (-0400)
Subject: usage
X-Git-Tag: v2.0.0~33^2
X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=refs%2Fheads%2Flegend-formatter;p=dygraphs.git

usage
---

diff --git a/src/dygraph-options-reference.js b/src/dygraph-options-reference.js
index 5bc6524..4b1a23b 100644
--- a/src/dygraph-options-reference.js
+++ b/src/dygraph-options-reference.js
@@ -466,8 +466,11 @@ OPTIONS_REFERENCE =  // <JSON>
   "legendFormatter": {
     "default": "null",
     "labels": ["Legend"],
-    "type": "function",
-    "description": "Set this to supply a custom formatter for the legend. See ..."
+    "type": "function(data): string",
+    "params": [
+      [ "data", "An object containing information about the selection (or lack of a selection). This includes formatted values and series information. See <a href=\"https://github.com/danvk/dygraphs/pull/683\">here</a> for sample values." ]
+    ],
+    "description": "Set this to supply a custom formatter for the legend. See <a href=\"https://github.com/danvk/dygraphs/pull/683\">this comment</a> and the <a href=\"tests/legend-formatter.html\">legendFormatter demo</a> for usage."
   },
   "labelsShowZeroValues": {
     "default": "true",