fix(tooltip): guard against removed series in cached axis tooltip params (Fixes #21732) - #21737
Open
waterWang wants to merge 1 commit into
Open
fix(tooltip): guard against removed series in cached axis tooltip params (Fixes #21732)#21737waterWang wants to merge 1 commit into
waterWang wants to merge 1 commit into
Conversation
Fixes apache#21732 _showAxisTooltip iterates `axisItem.seriesDataIndices` whose seriesIndex values come from the cached `_lastDataByCoordSys` pointer state. When a merged setOption removes series (e.g. `replaceMerge: ['series']`), those indices become stale and `getSeriesByIndex` returns undefined, causing: Uncaught TypeError: Cannot read properties of undefined (reading getDataParams) Also moved the `!axisModel` guard before the `axisModel.axis` access so a removed axis handles the same way instead of crashing earlier.
|
Thanks for your contribution! Please DO NOT commit the files in dist, i18n, and ssr/client/dist folders in a non-release pull request. These folders are for release use only. To reviewers: If this PR is going to be described in the changelog in the future release, please make sure this PR has one of the following labels: This message is shown because the PR description doesn't contain the document related template. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #21732
Problem
TooltipView._showAxisTooltipiteratesaxisItem.seriesDataIndiceswhoseseriesIndexvalues come from the cached pointer state (_lastDataByCoordSys). When a mergedsetOptionremoves series (e.g.replaceMerge: ['series', ...]) while the tooltip is still showing, those cached indices become stale andecModel.getSeriesByIndex(idxItem.seriesIndex)returnsundefined, causing:Root cause
TooltipViewcaches the last hovered pointer state in_lastX/_lastY/_lastDataByCoordSys.setOptionrunsTooltipView.render()→_keepShow(), which re-shows the tooltip with the cacheddataByCoordSysafter the update.getSeriesByIndexreturnsundefined→series.getDataParams(...)throws.Fix
Two defensive guards in
_showAxisTooltip:seriesDataIndicesentries whose series no longer exists:if (!series) { return; }!axisModelguard before theaxisModel.axisaccess (it was previously checked after being dereferenced), so a removed axis also short-circuits instead of crashing.Test
With
tooltip: {trigger: 'axis'}, hover to show the tooltip, thensetOptionwith fewer series in merge mode — the tooltip no longer throws and safely skips removed series.