Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inconsistent axis title standoff when title is one text line vs. multiple lines #6970

Merged
merged 6 commits into from
Apr 17, 2024

Conversation

my-tien
Copy link
Contributor

@my-tien my-tien commented Apr 16, 2024

Fixes: #6971.
The bug (codepen):
Notice the different spacing between ticklabels and axis title!
newplot(1)

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 scootTitle in Titles.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:

function titleLayout(titleEl) {
    Lib.syncOrAsync([drawTitle, /*scootTitle*/], titleEl);
}
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.

…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.
draftlogs/6970_fix.md Outdated Show resolved Hide resolved
@archmoj
Copy link
Contributor

archmoj commented Apr 16, 2024

Brilliant fix. 🎖️ 🏅 🥇
Please pick 1e69c85 or alternatively download and extract baselines.tar form Artifacts tab of https://app.circleci.com/pipelines/github/plotly/plotly.js/10216/workflows/f4a86aee-e57b-43a7-a0df-2fe27560ebb2/jobs/223383/artifacts and place the files in test/image/baselines/.

archmoj and others added 2 commits April 17, 2024 11:56
(cherry picked from commit 1e69c85)
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
Copy link
Contributor

@archmoj archmoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

different spacing between tick labels and axis title with multi line text
2 participants