From: etimberg <evert.timberg@gmail.com>
Date: Mon, 3 Jul 2017 22:00:03 +0000 (-0400)
Subject: Add a note on how to use getElementAtEvent in a click handler
X-Git-Tag: v2.7.0~1^2~63
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=9ec78cee1c18c596c1550b24c90b90eaa9ac17de;p=thirdparty%2FChart.js.git

Add a note on how to use getElementAtEvent in a click handler
---

diff --git a/docs/developers/api.md b/docs/developers/api.md
index 2875375ed..a5a0a5133 100644
--- a/docs/developers/api.md
+++ b/docs/developers/api.md
@@ -128,6 +128,19 @@ myLineChart.getElementAtEvent(e);
 // => returns the first element at the event point.
 ```
 
+To get an item that was clicked on, `getElementAtEvent` can be used.
+
+```javascript
+function clickHandler(evt) {
+    var item = myChart.getElementAtEvent(evt)[0];
+
+    if (item) {
+        var label = myChart.data.labels[firstPoint._index];
+        var value = myChart.data.datasets[firstPoint._datasetIndex].data[firstPoint._index];
+    }
+}
+```
+
 ## .getElementsAtEvent(e)
 
 Looks for the element under the event point, then returns all elements at the same data index. This is used internally for 'label' mode highlighting.