Repository navigation
feat(axis): add nameOffset applied after nameMoveOverlap resolution - #21840
Open
Faseehshahid246517 wants to merge 1 commit into
Open
Faseehshahid246517 wants to merge 1 commit into
Faseehshahid246517 wants to merge 1 commit into
Conversation
|
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. Document changes are required in this PR. Please also make a PR to apache/echarts-doc for document changes and update the issue id in the PR description. When the doc PR is merged, the maintainers will remove the |
This branch has not been deployed
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
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.
Brief Information
This pull request is in the type of:
What does this PR do?
Adds a new axis option
nameOffsetthat shifts the axis name by a pixel offset afternameGapand the automatic overlap resolution (nameMoveOverlap) have been applied.Fixed issues
nameMoveOverlap: trueDetails
Before: What was the problem?
With
nameMoveOverlap: true,nameGapis applied before overlap resolution. If the requested position still overlaps the axis labels, the axis name is moved automatically, so differentnameGapvalues can end up at the same final position. The overlap boundary depends on label size, font, rotation and data, so developers cannot predict which offset to use. The only workaround,nameMoveOverlap: false, disables automatic collision avoidance entirely.After: How does it behave after the fixing?
The new
nameOffsetoption is applied as the last step:nameGap-> overlap resolution ->nameOffset.number: signed pixel offset along the outward direction used by overlap resolution (positive = farther from the axis, negative = closer).[dx, dy]: screen-space pixel offset.0, so existing charts are unchanged.nameMoveOverlapistrueorfalse.Document Info
One of the following should be checked.
Misc
Security Checking
ZRender Changes
Related test cases or examples to use the new APIs
test/axis-name-offset.html(visual cases)test/ut/spec/component/axis/nameOffset.test.ts(unit tests)Merging options
Other information
Docs PR for



apache/echarts-docwill follow. I'm happy to adjust the API shape, for example dropping the[dx, dy]form if a smaller first version is preferred.