Add a way to filter items in the tooltip #3494
Conversation
| @@ -225,6 +225,7 @@ mode | String | 'nearest' | Sets which elements appear in the tooltip. See [Inte | |||
| intersect | Boolean | true | if true, the tooltip mode applies only when the mouse position intersects with an element. If false, the mode will be applied at all times. | |||
| position | String | 'average' | The mode for positioning the tooltip. 'average' mode will place the tooltip at the average position of the items displayed in the tooltip. 'nearest' will place the tooltip at the position of the element closest to the event position. New modes can be defined by adding functions to the Chart.Tooltip.positioners map. | |||
| itemSort | Function | undefined | Allows sorting of [tooltip items](#chart-configuration-tooltip-item-interface). Must implement at minimum a function that can be passed to [Array.prototype.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort). This function can also accept a third parameter that is the data object passed to the chart. | |||
| itemFilter | Function | undefined | Allows filtering of [tooltip items](#chart-configuration-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. | |||
There was a problem hiding this comment.
I was about to suggest to simply call this option filter, but then I looked above and see the itemSort, which one I would have called sorter, just because I like concise name.
There was a problem hiding this comment.
I can change this to filter since it is better.
There was a problem hiding this comment.
Not sure what the best: consistency with itemSort or simplicity with filter :)
etimberg
force-pushed
the
filter-tooltip-items
branch
from
67adb2e to
0b45eac
Compare
etimberg
force-pushed
the
filter-tooltip-items
branch
from
0b45eac to
b682c6e
Compare
|
Renamed function to |
|
I'm having issues with the |
|
@samueljo currently if all items are removed using the filter function, the tooltip will be blank. I'm happy to merge a PR that prevents this. I think it could be as simple as bailing out of |
Adds a function,
itemFilterto the tooltip config. If this function is specified, it is used to filter the items that show in the tooltip.I added a test to cover this case.
Fixes #1889