Fix inconsistent axis title standoff when title is one text line vs. multiple lines#6970
Merged
archmoj merged 6 commits intoplotly:masterfrom Apr 17, 2024
Merged
Conversation
…multiple lines. Previously, the standoff was calculated in the same way for all axis sides, but since the renderer draws from top left to bottom right, the code must be different for top/left axes titles and bottom/right axes titles: For top/left axes all lines after the first of a multiline title require extra space before the ticklabels, whereas for bottom/right axes, the drawing baseline needs to be shifted 1 line after the ticklabels to prevent overlap.
… y, g etc.) of the first line of the title as well.
Claimed to have standoff 8 although it has standoff 0.
archmoj
reviewed
Apr 16, 2024
Contributor
|
Brilliant fix. 🎖️ 🏅 🥇 |
(cherry picked from commit 1e69c85)
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
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.
Fixes: #6971.

The bug (codepen):
Notice the different spacing between ticklabels and axis title!
Previously, the standoff was calculated in the same way for all axis sides, but since the renderer draws from top left to bottom right, the code must be different for top/left axes titles and bottom/right axes titles: For top/left axes all lines after the first of a multiline title require extra space before the ticklabels, whereas for bottom/right axes, the drawing baseline needs to be shifted 1 line after the ticklabels to prevent overlap. This is what this PR does.
FYI if you want to try out the code yourself: Debugging this is difficult because there are multiple drawing passes. One way to simplify this is to comment out
scootTitleinTitles.draw(src/components/titles.index.js:120) whose only purpose is to shift the axis title in case it overlaps with either the paper border or another rendering object:Disclaimer
I am required to add that…the software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. in no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.