Tick label font family via tick_params #25746
Conversation
lib/matplotlib/axis.pyi
Outdated
| @@ -36,6 +36,7 @@ class Tick(martist.Artist): | |||
| pad: float | None = ..., | |||
| labelsize: float | None = ..., | |||
| labelcolor: ColorType | None = ..., | |||
| labelFont: Sequence[str] = ..., | |||
There was a problem hiding this comment.
I think you are conflating "font" with "font family" here. These are two different properties with different types expected. The former is an Alias of "fontproperties" and accepts a font_manager.FontProperties object as well as a few other options to pass into the constructor thereof. The latter accepts str | Iterable[str]
Both behave equivalently when passed a str, as in your test, but font also allows setting other attributes of the font, such as size and color.
Also your indentation and capitalization are not consistent here.
And this is (surprisingly) the first reference to Sequence (or Iterable) in this file so whichever is used (if kept) should be imported from collections.abc.
There was a problem hiding this comment.
I think for consistency, it should likely be spelled out that this is setting the labelfontfamily (if that is the type you expect to pass) or the labelfontproperties (as it is implemented, in which case the type hint should match that underlying Text setter).
Further, though if you do keep it as labelfontfamily, it does need to be type hinted as str | Sequence[str] | None (str because that is what you actually pass in the test, None because None is the default)
lib/matplotlib/axis.py
Outdated
| @@ -175,11 +175,11 @@ def __init__( | |||
| self.label1 = mtext.Text( | |||
| np.nan, np.nan, | |||
| fontsize=labelsize, color=labelcolor, visible=label1On, | |||
| fontproperties=labelfont, rotation=self._labelrotation[1]) | |||
| fontproperties=labelfontfamily, rotation=self._labelrotation[1]) | |||
There was a problem hiding this comment.
| fontproperties=labelfontfamily, rotation=self._labelrotation[1]) | |
| fontfamily=labelfontfamily, rotation=self._labelrotation[1]) |
lib/matplotlib/axis.py
Outdated
| self.label2 = mtext.Text( | ||
| np.nan, np.nan, | ||
| fontsize=labelsize, color=labelcolor, visible=label2On, | ||
| fontproperties=labelfont, rotation=self._labelrotation[1]) | ||
| fontproperties=labelfontfamily, rotation=self._labelrotation[1]) |
There was a problem hiding this comment.
| fontproperties=labelfontfamily, rotation=self._labelrotation[1]) | |
| fontfamily=labelfontfamily, rotation=self._labelrotation[1]) |
|
|
||
| .. code-block:: python | ||
|
|
||
| Axis.tick_params(labelfont='monospace') |
There was a problem hiding this comment.
| Axis.tick_params(labelfont='monospace') | |
| Axis.tick_params(labelfontfamily='monospace') |
PR Summary
Closes #18425. Added a
labelfontkwarg to change tick label fonts conveniently, without changing the rest of the text.PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst