diff --git a/js/ui/chart/docs/general/interactions/events.md b/js/ui/chart/docs/general/interactions/events.md new file mode 100644 index 0000000..51e3bf4 --- /dev/null +++ b/js/ui/chart/docs/general/interactions/events.md @@ -0,0 +1,21 @@ +# Events +The following properties define how the chart interacts with events. + +| Name | Type | Default | Description +| ---- | ---- | ------- | ----------- +| `events` | `string[]` | `['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']` | The `events` option defines the browser events that the chart should listen to for tooltips and hovering. [more...](#event-option) +| `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). +| `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. + +## Event Option +For example, to have the chart only respond to click events, you could do: +```javascript +var chart = new Chart(ctx, { + type: 'line', + data: data, + options: { + // This chart will not respond to mousemove, etc + events: ['click'] + } +}); +```