Add legend.labelcolor in rcParams #20084

Carloscerq · 2021-04-26T23:37:47Z

PR Summary

This is a proposal for a new legend rcParam.
The legend.labelcolor was proposed in #20049. It's for changing the labelcolor of all figures(similar to the labelcolor of plt.legend)

Example:

import numpy as np
import lib.matplotlib.pyplot as plt

a = np.arange(2, 3, .02)
c = np.exp(a)
plt.rcParams['legend.labelcolor'] = 'linecolor'

fig, ax = plt.subplots()
ax.plot(a, c, 'g', label='Model length')
ax.plot(c, a, 'r', label='Data length')

legend = ax.legend()

plt.show()

PR Checklist

Has pytest style unit tests (and pytest passes).
Is Flake 8 compliant (run flake8 on changed files to check).
New features are documented, with examples if plot related.
Documentation is sphinx and numpydoc compliant (the docs should build without error).
Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

tacaswell · 2021-04-28T02:45:43Z

Thanks for working on this!

Overall 👍, but is it possible to have the default rcParam be None? Currently the default label color will fall back to the rcParams['text.color'] but with this PR will default to 'black'

Carloscerq · 2021-04-28T14:21:37Z

Sure. I think that making a little change in the lib/matplotlib/legend.py it can work. I will give it a try.

doc/users/next_whats_new/rcparams_legend.rst

lib/matplotlib/rcsetup.py

doc/users/next_whats_new/rcparams_legend.rst

jklymak · 2021-05-10T21:55:08Z

lib/matplotlib/legend.py

@@ -544,8 +544,11 @@ def __init__(self, parent, handles, labels,
            'mec':             ['get_markeredgecolor', 'get_edgecolor'],
        }
        if labelcolor is None:
-            pass
-        elif isinstance(labelcolor, str) and labelcolor in color_getters:
+            if mpl.rcParams['legend.labelcolor'] != 'none':


The legend docstring should note that this rcparam exists....

Should this be `

Suggested change

if mpl.rcParams['legend.labelcolor'] != 'none':

if mpl.rcParams['legend.labelcolor'] is not None:

along with similar changes to validator? There are a number of places where we use the string 'none' as a color to mean "this thing does not get a color" and None (the singleton) to mean "use the default color".

That said, currently doing

... ax.legend(labelcolor='none')

does not result in an invisible label which is a bug in the implementation below (cycle of a 0 length thing is also 0 length, not infinite).

The rcParam can't be able to both be None and 'none', though, right? The fallback version would need a special value to work, like 'auto' or 'textcolor'?

#20225 fixes the bug I noted above!

jklymak · 2021-05-13T14:22:36Z

lib/matplotlib/legend.py

@@ -179,6 +179,8 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
    also be made to match the color of the line or marker using 'linecolor',
    'markerfacecolor' (or 'mfc'), or 'markeredgecolor' (or 'mec').

+    Otherly, labelcolor can be set globally using :rc:`legend.labelcolor`.
+


Sorry to be picky, bit this should go in as

labelcolor : str or list, default: :rc:`legend.labelcolor`.

Thanks for the review.
But when the rcParams[legend.labelcolor] is None(the default value(, should the docs say that it just uses the rcParams['text.color'] value?

I think that should be specified in the description of the parameter if it is not already

This is fine w/ me now. @tacaswell you have a block on this...

tacaswell

Looks on the right path, but the default value should be None not 'none'.

tacaswell · 2021-05-14T03:05:06Z

lib/matplotlib/legend.py

@@ -544,8 +544,11 @@ def __init__(self, parent, handles, labels,
            'mec':             ['get_markeredgecolor', 'get_edgecolor'],
        }
        if labelcolor is None:
-            pass
-        elif isinstance(labelcolor, str) and labelcolor in color_getters:
+            if mpl.rcParams['legend.labelcolor'] != 'none':


Should this be `

Suggested change

if mpl.rcParams['legend.labelcolor'] != 'none':

if mpl.rcParams['legend.labelcolor'] is not None:

along with similar changes to validator? There are a number of places where we use the string 'none' as a color to mean "this thing does not get a color" and None (the singleton) to mean "use the default color".

That said, currently doing

... ax.legend(labelcolor='none')

does not result in an invisible label which is a bug in the implementation below (cycle of a 0 length thing is also 0 length, not infinite).

doc/users/next_whats_new/rcparams_legend.rst

lib/matplotlib/legend.py

jklymak · 2021-05-22T15:53:10Z

@tacaswell you are still blocking on this....

tacaswell · 2021-05-22T22:08:16Z

Thanks @Carloscerq ! Congratulations on your first merged Matplotlib PR 🎉 hope we hear from you again!

github-actions bot reviewed Apr 26, 2021

View reviewed changes

Carloscerq marked this pull request as draft April 27, 2021 21:03

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 64661db to 2216de0 Compare April 27, 2021 22:53

QuLogic added New feature topic: legend topic: rcparams labels Apr 27, 2021

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 2216de0 to 9652ce5 Compare April 28, 2021 00:28

Carloscerq marked this pull request as ready for review April 28, 2021 01:28

Carloscerq marked this pull request as draft April 28, 2021 01:42

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 9652ce5 to 5fbf7cf Compare April 28, 2021 02:02

Carloscerq marked this pull request as ready for review April 28, 2021 02:44

tacaswell added this to the v3.5.0 milestone Apr 28, 2021

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 5fbf7cf to 2dabca5 Compare April 28, 2021 23:18

QuLogic reviewed Apr 29, 2021

View reviewed changes

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch 3 times, most recently from 7dc4eaa to a76663b Compare April 30, 2021 04:00

QuLogic approved these changes Apr 30, 2021

View reviewed changes

doc/users/next_whats_new/rcparams_legend.rst Outdated Show resolved Hide resolved

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch 2 times, most recently from 411cfac to 942c3b2 Compare April 30, 2021 16:54

jklymak reviewed May 10, 2021

View reviewed changes

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch 3 times, most recently from 5fb07c8 to 8240661 Compare May 11, 2021 13:02

jklymak reviewed May 13, 2021

View reviewed changes

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch 2 times, most recently from 53bde8f to c905216 Compare May 14, 2021 01:37

tacaswell requested changes May 14, 2021

View reviewed changes

tacaswell mentioned this pull request May 14, 2021

FIX: correctly handle ax.legend(..., legendcolor='none') #20225

Merged

3 tasks

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from c905216 to ffbd8b9 Compare May 14, 2021 16:43

Carloscerq marked this pull request as draft May 16, 2021 17:52

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 49ac9a2 to 4397fa8 Compare May 16, 2021 17:58

Carloscerq marked this pull request as ready for review May 16, 2021 19:07

jklymak requested a review from tacaswell May 17, 2021 15:40

jklymak reviewed May 17, 2021

View reviewed changes

doc/users/next_whats_new/rcparams_legend.rst Outdated Show resolved Hide resolved

QuLogic reviewed May 17, 2021

View reviewed changes

lib/matplotlib/legend.py Outdated Show resolved Hide resolved

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 4397fa8 to 8354d0e Compare May 18, 2021 02:18

Add legend.labelcolor in rcParams

13149be

Carloscerq force-pushed the add_legend_labelcolor_rcParam branch from 8354d0e to 13149be Compare May 20, 2021 02:37

jklymak approved these changes May 22, 2021

View reviewed changes

tacaswell approved these changes May 22, 2021

View reviewed changes

tacaswell merged commit 9b9c42d into matplotlib:master May 22, 2021

tacaswell mentioned this pull request Jun 30, 2021

add legend.labelcolor "argument" to mplstyle stylesheet #20049

Closed

	if mpl.rcParams['legend.labelcolor'] != 'none':
	if mpl.rcParams['legend.labelcolor'] is not None:

Uh oh!

Add legend.labelcolor in rcParams #20084

Add legend.labelcolor in rcParams #20084

Uh oh!

Conversation

Carloscerq commented Apr 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Apr 28, 2021

Uh oh!

Carloscerq commented Apr 28, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuLogic May 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jklymak commented May 22, 2021

Uh oh!

tacaswell commented May 22, 2021

Uh oh!

Uh oh!

Carloscerq commented Apr 26, 2021 •

edited

Loading

QuLogic May 14, 2021 •

edited

Loading