Add parameters to tooltip filter option (#7556)

diff --git a/docs/docs/configuration/tooltip.md b/docs/docs/configuration/tooltip.md
index cd98fdca9d8f7490a89907142f6f3911268de8a9..5647095bc0e821fbad4d9944cd3f47ba3fa1dabc 100644 (file)
--- a/docs/docs/configuration/tooltip.md
+++ b/docs/docs/configuration/tooltip.md
@@ -93,7 +93,7 @@ Allows sorting of [tooltip items](#tooltip-item-interface). Must implement at mi
 
 ### Filter Callback
 
-Allows filtering of [tooltip items](#tooltip-item-interface). Must implement at minimum a function that can be passed to [Array.prototype.filter](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). This function can also accept a second parameter that is the data object passed to the chart.
+Allows filtering of [tooltip items](#tooltip-item-interface). Must implement at minimum a function that can be passed to [Array.prototype.filter](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). This function can also accept a fourth parameter that is the data object passed to the chart.
 
 ## Tooltip Callbacks
 

diff --git a/docs/docs/getting-started/v3-migration.md b/docs/docs/getting-started/v3-migration.md
index 3f0d3f5f5b5eac9081610fefcd1ffe5f405e131f..a5974aea2067236b18e44bba260a12ace874ee41 100644 (file)
--- a/docs/docs/getting-started/v3-migration.md
+++ b/docs/docs/getting-started/v3-migration.md
@@ -185,6 +185,7 @@ Animation system was completely rewritten in Chart.js v3. Each property can now
 #### Tooltip
 
 * `xLabel` and `yLabel` were removed. Please use `index` and `value`
+* The `filter` option will now be passed additional parameters when called and should have the method signature `function(tooltipItem, index, tooltipItems, data)`
 
 ## Developer migration
 

diff --git a/src/plugins/plugin.tooltip.js b/src/plugins/plugin.tooltip.js
index 6f239f64be3b2426029212b945e50f442a037be2..2ca517b5d31a3ef1bb4da5c42251d290bffd0ca1 100644 (file)
--- a/src/plugins/plugin.tooltip.js
+++ b/src/plugins/plugin.tooltip.js
@@ -602,7 +602,7 @@ export class Tooltip extends Element {
 
                // If the user provided a filter function, use it to modify the tooltip items
                if (options.filter) {
-                       tooltipItems = tooltipItems.filter((a) => options.filter(a, data));
+                       tooltipItems = tooltipItems.filter((element, index, array) => options.filter(element, index, array, data));
                }
 
                // If the user provided a sorting function, use it to modify the tooltip items

diff --git a/test/specs/plugin.tooltip.tests.js b/test/specs/plugin.tooltip.tests.js
index 3478102b2d71e7331b44a44c0856c6b57a76ec5e..1e1aa8c172651cd9f74bd1e5e96a7421579a3ee7 100644 (file)
--- a/test/specs/plugin.tooltip.tests.js
+++ b/test/specs/plugin.tooltip.tests.js
@@ -706,7 +706,7 @@ describe('Core.Tooltip', function() {
                        options: {
                                tooltips: {
                                        mode: 'index',
-                                       filter: function(tooltipItem, data) {
+                                       filter: function(tooltipItem, index, tooltipItems, data) {
                                                // For testing purposes remove the first dataset that has a tooltipHidden property
                                                return !data.datasets[tooltipItem.datasetIndex].tooltipHidden;
                                        }