Mirrors/Chart.js
2
0
Fork 0
mirror of https://github.com/chartjs/Chart.js.git synced 2026-03-09 09:46:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Pass the hover event to the onHover event handler (#3669)

Browse Source 
Pass the hover event to the onHover event handler

This makes the behavior of the `onHover` handler consistent with the `onClick` handler:

```
function(event, activeElements) {
    var chartInstance = this;
}
```
This commit is contained in:
Jonathon Hill
2016-12-03 17:42:33 -05:00
committed by Evert Timberg
parent 5a24bfa500
commit 152ce9c9f8
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/01-Chart-Configuration.md
View File

@@ -81,7 +81,7 @@ responsive | Boolean | true | Resizes the chart canvas when its container does.
responsiveAnimationDuration | Number | 0 | Duration in milliseconds it takes to animate to new size after a resize event.
maintainAspectRatio | Boolean | true | Maintain the original canvas aspect ratio `(width / height)` when resizing
events | Array[String] | `["mousemove", "mouseout", "click", "touchstart", "touchmove", "touchend"]` | Events that the chart should listen to for tooltips and hovering
onClick | Function | null | Called if the event is of type 'mouseup' or 'click'. Called in the context of the chart and passed an array of active elements
onClick | Function | null | Called if the event is of type 'mouseup' or 'click'. Called in the context of the chart and passed the event and an array of active elements
legendCallback | Function | ` function (chart) { }` | Function to generate a legend. Receives the chart object to generate a legend from. Default implementation returns an HTML string.
onResize | Function | null | Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.
@@ -310,7 +310,7 @@ Name | Type | Default | Description
mode | String | 'nearest' | Sets which elements appear in the tooltip. See [Interaction Modes](#interaction-modes) for details
intersect | Boolean | true | if true, the hover mode only applies when the mouse position intersects an item on the chart
animationDuration | Number | 400 | Duration in milliseconds it takes to animate hover style changes
onHover | Function | null | Called when any of the events fire. Called in the context of the chart and passed an array of active elements (bars, points, etc)
onHover | Function | null | Called when any of the events fire. Called in the context of the chart and passed the event and an array of active elements (bars, points, etc)
### Interaction Modes
When configuring interaction with the graph via hover or tooltips, a number of different modes are available.

2
src/core/core.controller.js
View File

@@ -796,7 +796,7 @@ module.exports = function(Chart) {
// On Hover hook
if (hoverOptions.onHover) {
hoverOptions.onHover.call(me, me.active);
hoverOptions.onHover.call(me, e, me.active);
}
if (e.type === 'mouseup' || e.type === 'click') {