Skip to content

Add manual text staggering for overlapping labels #618

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.

Sign up for GitHub

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

Draft
cvanelteren wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Add manual text staggering for overlapping labels #618

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4e82d28
Add manual text staggering helper
cvanelteren Mar 17, 2026
b42cee0
Support 2D text staggering
cvanelteren Mar 17, 2026
4e1199e
Potential fix for pull request finding
cvanelteren Mar 17, 2026
3cab9ae
Potential fix for pull request finding
cvanelteren Mar 17, 2026
49b32a4
Document stagger_text direction aliases
cvanelteren Mar 17, 2026
4b795eb
Fix stagger_text cached state names
cvanelteren Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Document stagger_text direction aliases
  • Loading branch information
@cvanelteren
cvanelteren committed Mar 17, 2026
commit 49b32a488912946f876d1be25f98be815f651858
6 changes: 4 additions & 2 deletions ultraplot/axes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4168,8 +4168,10 @@ def stagger_text(
artists : sequence of `~matplotlib.text.Text`, optional
The artists to stagger. Defaults to visible axes text and annotation
artists added with `text` or `annotate`.
direction : {'x', 'y', 'both', 'horizontal', 'vertical'}, default: 'y'
The staggering direction.
direction : {'x', 'y', 'both', 'xy', '2d', 'horizontal', 'vertical'}, \
default: 'y'
The staggering direction. Use ``'both'``, ``'xy'``, or ``'2d'``
to search in both horizontal and vertical directions.
step : float or unit-spec, default: '0.8em'
The offset increment applied while searching for a non-overlapping
position.
Expand Down
4 changes: 3 additions & 1 deletion ultraplot/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2999,7 +2999,9 @@ def stagger_text(
The axes whose text artists should be staggered. Defaults to the
numbered subplots in the figure.
direction, step, pad, max_steps, renderer
Passed to `~ultraplot.axes.Axes.stagger_text`.
Passed to `~ultraplot.axes.Axes.stagger_text`. This includes the
``'both'``, ``'xy'``, and ``'2d'`` direction aliases for
two-dimensional staggering.

Returns
-------
Expand Down
Loading