Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a note on how to use getElementAtEvent in a click handler #4456

Merged
merged 1 commit into from
Jul 4, 2017
Merged

Add a note on how to use getElementAtEvent in a click handler #4456

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/developers/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down