]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Add a note on how to use getElementAtEvent in a click handler
authoretimberg <evert.timberg@gmail.com>
Mon, 3 Jul 2017 22:00:03 +0000 (18:00 -0400)
committerEvert Timberg <evert.timberg+github@gmail.com>
Tue, 4 Jul 2017 11:26:18 +0000 (07:26 -0400)
docs/developers/api.md

index 2875375ed503db45a34a5cf725993c8d1c1a5e98..a5a0a51339663b12b87708deff7d12ca2ed426d4 100644 (file)
@@ -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.