Skip to content

Support individual styling of major and minor grid through rcParams #29481

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
QuLogic merged 24 commits into from
Jun 24, 2025
Merged

Support individual styling of major and minor grid through rcParams #29481

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
bffeb0a
Possible fix for issue #13919
konmenel Jan 17, 2025
87726b6
fix flake warnings
konmenel Jan 18, 2025
e3d22aa
Resolve suggested changes
konmenel Jan 27, 2025
536b52e
Add new validators in stub file
konmenel Jan 27, 2025
397a2ad
make stub file arguments same as runtime
konmenel Jan 27, 2025
87339d8
Add distinction for x and y axis in grid line options
konmenel Jan 28, 2025
09a7346
fix flake8
konmenel Jan 28, 2025
42e0054
Add What's New note
konmenel Jan 28, 2025
39eef79
Extend `_val_or_rc` to support multiply names
konmenel Jan 28, 2025
a4e6f44
Fix linting for and _validate_linestyle_or_None to mypy allowlist
konmenel Jan 28, 2025
9a2b2b2
Remove validate linestyle functions from stubtest allow list
konmenel Jan 28, 2025
c886330
Revert change to just grid.major/minor distinction in rcParams
konmenel Jan 29, 2025
cd3c260
Update What's New note and reduced example
konmenel Jan 29, 2025
456034c
Add testing for `grid.major/minor.*` in rcParams
konmenel Jan 29, 2025
ca5a443
fix indentation and linting
konmenel Jan 29, 2025
b455d6b
Fix example description
konmenel Jan 29, 2025
2cb99fc
Fix spelling
konmenel Jan 29, 2025
6552586
Merge branch 'main' into fix-issue-13919
timhoffm Jan 31, 2025
830b8a0
Fix type
konmenel Jun 9, 2025
5b623a3
Fix formatting
konmenel Jun 9, 2025
6db787a
`validate_color_or_None` private and fix argument names
konmenel Jun 9, 2025
a6db063
Fix validator name in stub file as well
konmenel Jun 9, 2025
c14aa8a
correct validators for grid.*.color keys
konmenel Jun 9, 2025
1ae82eb
Revert change in mypy-stubtest-allowlist.txt
konmenel Jun 18, 2025
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
Add distinction for x and y axis in grid line options
  • Loading branch information
@konmenel
konmenel committed Jan 28, 2025
commit 87339d8c7876ffb6e955779e65288565f1857060
25 changes: 17 additions & 8 deletions lib/matplotlib/axis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ def __init__(

name = self.__name__
major_minor = "major" if major else "minor"
xaxis_yaxis = "xaxis" if name == "xtick" else "yaxis"
self._size = mpl._val_or_rc(size, f"{name}.{major_minor}.size")
self._width = mpl._val_or_rc(width, f"{name}.{major_minor}.width")
self._base_pad = mpl._val_or_rc(pad, f"{name}.{major_minor}.pad")
Expand All @@ -125,19 +126,25 @@ def __init__(
self._zorder = zorder

grid_color = (
mpl._val_or_rc(grid_color, "grid.color")
if mpl.rcParams[f"grid.{major_minor}.color"] is None
mpl._val_or_rc(grid_color, f"grid.{xaxis_yaxis}.{major_minor}.color")
if mpl.rcParams[f"grid.{xaxis_yaxis}.{major_minor}.color"] is not None
else mpl._val_or_rc(grid_color, f"grid.{major_minor}.color")
if mpl.rcParams[f"grid.{major_minor}.color"] is not None
else mpl._val_or_rc(grid_color, "grid.color")
)
grid_linestyle = (
mpl._val_or_rc(grid_linestyle, "grid.linestyle")
if mpl.rcParams[f"grid.{major_minor}.linestyle"] is None
mpl._val_or_rc(grid_linestyle, f"grid.{xaxis_yaxis}.{major_minor}.linestyle")
if mpl.rcParams[f"grid.{xaxis_yaxis}.{major_minor}.linestyle"] is not None
else mpl._val_or_rc(grid_linestyle, f"grid.{major_minor}.linestyle")
if mpl.rcParams[f"grid.{major_minor}.linestyle"] is not None
else mpl._val_or_rc(grid_linestyle, "grid.linestyle")
)
grid_linewidth = (
mpl._val_or_rc(grid_linewidth, "grid.linewidth")
if mpl.rcParams[f"grid.{major_minor}.linewidth"] is None
mpl._val_or_rc(grid_linewidth, f"grid.{xaxis_yaxis}.{major_minor}.linewidth")
if mpl.rcParams[f"grid.{xaxis_yaxis}.{major_minor}.linewidth"] is not None
else mpl._val_or_rc(grid_linewidth, f"grid.{major_minor}.linewidth")
if mpl.rcParams[f"grid.{major_minor}.linewidth"] is not None
else mpl._val_or_rc(grid_linewidth, "grid.linewidth")
)
if grid_alpha is None and not mcolors._has_alpha_channel(grid_color):
# alpha precedence: kwarg > color alpha > rcParams['grid.alpha']
Expand All @@ -146,9 +153,11 @@ def __init__(
# grid(color=(1, 1, 1, 0.5), alpha=rcParams['grid.alpha'])
# so the that the rcParams default would override color alpha.
grid_alpha = (
mpl.rcParams["grid.alpha"]
if mpl.rcParams[f"grid.{major_minor}.alpha"] is None
mpl.rcParams[f"grid.{xaxis_yaxis}.{major_minor}.alpha"]
if mpl.rcParams[f"grid.{xaxis_yaxis}.{major_minor}.alpha"] is not None
else mpl.rcParams[f"grid.{major_minor}.alpha"]
if mpl.rcParams[f"grid.{major_minor}.alpha"] is not None
else mpl.rcParams["grid.alpha"]
)
grid_kw = {k[5:]: v for k, v in kwargs.items()}

Expand Down
20 changes: 20 additions & 0 deletions lib/matplotlib/mpl-data/matplotlibrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,26 @@
#grid.minor.linewidth: None # If None defaults to grid.linewidth
#grid.minor.alpha: None # If None defaults to grid.alpha

#grid.xaxis.major.color: None # If None defaults to grid.color
#grid.xaxis.major.linestyle: None # If None defaults to grid.linestyle
#grid.xaxis.major.linewidth: None # If None defaults to grid.linewidth
#grid.xaxis.major.alpha: None # If None defaults to grid.alpha

#grid.xaxis.minor.color: None # If None defaults to grid.color
#grid.xaxis.minor.linestyle: None # If None defaults to grid.linestyle
#grid.xaxis.minor.linewidth: None # If None defaults to grid.linewidth
#grid.xaxis.minor.alpha: None # If None defaults to grid.alpha

#grid.yaxis.major.color: None # If None defaults to grid.color
#grid.yaxis.major.linestyle: None # If None defaults to grid.linestyle
#grid.yaxis.major.linewidth: None # If None defaults to grid.linewidth
#grid.yaxis.major.alpha: None # If None defaults to grid.alpha

#grid.yaxis.minor.color: None # If None defaults to grid.color
#grid.yaxis.minor.linestyle: None # If None defaults to grid.linestyle
#grid.yaxis.minor.linewidth: None # If None defaults to grid.linewidth
#grid.yaxis.minor.alpha: None # If None defaults to grid.alpha


## ***************************************************************************
## * LEGEND *
Expand Down
20 changes: 20 additions & 0 deletions lib/matplotlib/rcsetup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1260,6 +1260,26 @@ def _convert_validator_spec(key, conv):
"grid.minor.linewidth": validate_float_or_None, # in points
"grid.minor.alpha": validate_float_or_None,

"grid.xaxis.major.color": validate_color_or_None, # grid color
"grid.xaxis.major.linestyle": _validate_linestyle_or_None, # solid
"grid.xaxis.major.linewidth": validate_float_or_None, # in points
"grid.xaxis.major.alpha": validate_float_or_None,

"grid.xaxis.minor.color": validate_color_or_None, # grid color
"grid.xaxis.minor.linestyle": _validate_linestyle_or_None, # solid
"grid.xaxis.minor.linewidth": validate_float_or_None, # in points
"grid.xaxis.minor.alpha": validate_float_or_None,

"grid.yaxis.major.color": validate_color_or_None, # grid color
"grid.yaxis.major.linestyle": _validate_linestyle_or_None, # solid
"grid.yaxis.major.linewidth": validate_float_or_None, # in points
"grid.yaxis.major.alpha": validate_float_or_None,

"grid.yaxis.minor.color": validate_color_or_None, # grid color
"grid.yaxis.minor.linestyle": _validate_linestyle_or_None, # solid
"grid.yaxis.minor.linewidth": validate_float_or_None, # in points
"grid.yaxis.minor.alpha": validate_float_or_None,

Comment thread
konmenel marked this conversation as resolved.
Outdated
## figure props
# figure title
"figure.titlesize": validate_fontsize,
Expand Down