Skip to content

Support col_wrap="auto" #11266

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

Merged
jsignell merged 8 commits into from
Apr 13, 2026
Merged

Support col_wrap="auto" #11266

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
692cda5
support for col_wrap='auto'
headtr1ck Mar 26, 2026
a78eeb1
add tests
headtr1ck Mar 26, 2026
ee53ea3
amend changelog
headtr1ck Mar 26, 2026
6225364
align grid to figsize
headtr1ck Mar 27, 2026
770ff55
simplify tuple gen
headtr1ck Mar 27, 2026
1b3b8c1
support extreme figsizes
headtr1ck Mar 27, 2026
31d2f51
now even support aspect
headtr1ck Mar 27, 2026
084a83f
Merge branch 'main' into auto-col
jsignell Apr 13, 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
3 changes: 3 additions & 0 deletions doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ New Features
- Added ``inherit='all_coords'`` option to :py:meth:`DataTree.to_dataset` to inherit
all parent coordinates, not just indexed ones (:issue:`10812`, :pull:`11230`).
By `Alfonso Ladino <https://github.com/aladinor>`_.
- Support ``col_wrap='auto'`` in plots that will wrap the grid to be as square
as possible (:pull:`11266`).
By `Michael Niklas <https://github.com/headtr1ck>`_.

Breaking Changes
~~~~~~~~~~~~~~~~
Expand Down
54 changes: 27 additions & 27 deletions xarray/plot/accessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def scatter( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_legend: bool | None = None,
Expand Down Expand Up @@ -232,7 +232,7 @@ def scatter(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_legend: bool | None = None,
Expand Down Expand Up @@ -272,7 +272,7 @@ def scatter(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_legend: bool | None = None,
Expand Down Expand Up @@ -311,7 +311,7 @@ def imshow( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -350,7 +350,7 @@ def imshow(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -389,7 +389,7 @@ def imshow(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -432,7 +432,7 @@ def contour( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -471,7 +471,7 @@ def contour(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -510,7 +510,7 @@ def contour(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -553,7 +553,7 @@ def contourf( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -592,7 +592,7 @@ def contourf(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -631,7 +631,7 @@ def contourf(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -674,7 +674,7 @@ def pcolormesh( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -713,7 +713,7 @@ def pcolormesh(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -752,7 +752,7 @@ def pcolormesh(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -795,7 +795,7 @@ def surface(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -834,7 +834,7 @@ def surface(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -873,7 +873,7 @@ def surface(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_colorbar: bool | None = None,
Expand Down Expand Up @@ -940,7 +940,7 @@ def scatter( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
row: None = None, # no wrap -> primitive
col: None = None, # no wrap -> primitive
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_legend: bool | None = None,
Expand Down Expand Up @@ -980,7 +980,7 @@ def scatter(
ax: Axes | None = None,
row: Hashable | None = None,
col: Hashable, # wrap -> FacetGrid
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_legend: bool | None = None,
Expand Down Expand Up @@ -1020,7 +1020,7 @@ def scatter(
ax: Axes | None = None,
row: Hashable, # wrap -> FacetGrid
col: Hashable | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
xincrease: bool | None = True,
yincrease: bool | None = True,
add_legend: bool | None = None,
Expand Down Expand Up @@ -1062,7 +1062,7 @@ def quiver( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
figsize: Iterable[float] | None = None,
size: float | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
sharex: bool = True,
sharey: bool = True,
aspect: AspectOptions = None,
Expand Down Expand Up @@ -1098,7 +1098,7 @@ def quiver(
ax: Axes | None = None,
figsize: Iterable[float] | None = None,
size: float | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
sharex: bool = True,
sharey: bool = True,
aspect: AspectOptions = None,
Expand Down Expand Up @@ -1134,7 +1134,7 @@ def quiver(
ax: Axes | None = None,
figsize: Iterable[float] | None = None,
size: float | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
sharex: bool = True,
sharey: bool = True,
aspect: AspectOptions = None,
Expand Down Expand Up @@ -1174,7 +1174,7 @@ def streamplot( # type: ignore[misc,unused-ignore] # None is hashable :(
ax: Axes | None = None,
figsize: Iterable[float] | None = None,
size: float | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
sharex: bool = True,
sharey: bool = True,
aspect: AspectOptions = None,
Expand Down Expand Up @@ -1210,7 +1210,7 @@ def streamplot(
ax: Axes | None = None,
figsize: Iterable[float] | None = None,
size: float | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
sharex: bool = True,
sharey: bool = True,
aspect: AspectOptions = None,
Expand Down Expand Up @@ -1246,7 +1246,7 @@ def streamplot(
ax: Axes | None = None,
figsize: Iterable[float] | None = None,
size: float | None = None,
col_wrap: int | None = None,
col_wrap: int | Literal["auto"] | None = None,
sharex: bool = True,
sharey: bool = True,
aspect: AspectOptions = None,
Expand Down
Loading
Loading