Add manual text staggering for overlapping labels#618
Draft
cvanelteren wants to merge 6 commits intomainfrom
Draft
Add manual text staggering for overlapping labels#618cvanelteren wants to merge 6 commits intomainfrom
cvanelteren wants to merge 6 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an explicit “stagger text” utility to UltraPlot axes (and a figure-level convenience wrapper) to automatically offset overlapping Text/Annotation artists, with tests validating overlap reduction and idempotency.
Changes:
- Implement
Axes.stagger_text(...)to iteratively offset text/annotation artists in display space until their bboxes no longer overlap. - Implement
Figure.stagger_text(...)to apply axes-level staggering across a figure’s selected subplots. - Add unit tests covering vertical/horizontal/both-direction staggering, figure-level defaults, and idempotency.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
ultraplot/axes/base.py |
Adds the core staggering algorithm and helpers on Axes. |
ultraplot/figure.py |
Adds axes selection helper and a figure-level stagger_text wrapper. |
ultraplot/tests/test_axes.py |
Adds tests for axes-level staggering across directions and idempotency. |
ultraplot/tests/test_figure.py |
Adds tests for figure-level staggering across subplots and selection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@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.
This adds an explicit text-staggering helper for dense figures without changing the default behavior of text placement.
Axes.stagger_text()can now offset existingtext()andannotate()artists horizontally, vertically, or in two dimensions to reduce overlap, andFigure.stagger_text()applies the same behavior across selected subplots while keeping each subplot independent. The PR also adds targeted regressions for text, annotation, idempotency, and figure-level selection behavior. Closes #617.