Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit aa857ad

Browse files
committed
Document new kwargs in Axes.legend docstring
1 parent 0da7740 commit aa857ad

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ def legend(self, *args, **kwargs):
408408
label
409409
410410
frameon : None or bool
411-
Control whether a frame should be drawn around the legend.
411+
Control whether the legend should be drawn on a patch (frame).
412412
Default is ``None`` which will take the value from the
413413
``legend.frameon`` :data:`rcParam<matplotlib.rcParams>`.
414414
@@ -425,10 +425,24 @@ def legend(self, *args, **kwargs):
425425
``legend.shadow`` :data:`rcParam<matplotlib.rcParams>`.
426426
427427
framealpha : None or float
428-
Control the alpha transparency of the legend's frame.
428+
Control the alpha transparency of the legend's background.
429429
Default is ``None`` which will take the value from the
430430
``legend.framealpha`` :data:`rcParam<matplotlib.rcParams>`.
431431
432+
facecolor : None or "inherit" or a color spec
433+
Control the legend's background color.
434+
Default is ``None`` which will take the value from the
435+
``legend.facecolor`` :data:`rcParam<matplotlib.rcParams>`.
436+
If ``"inherit"``, it will take the ``axes.facecolor``
437+
:data:`rcParam<matplotlib.rcParams>`.
438+
439+
edgecolor : None or "inherit" or a color spec
440+
Control the legend's background patch edge color.
441+
Default is ``None`` which will take the value from the
442+
``legend.edgecolor`` :data:`rcParam<matplotlib.rcParams>`.
443+
If ``"inherit"``, it will take the ``axes.edgecolor``
444+
:data:`rcParam<matplotlib.rcParams>`.
445+
432446
mode : {"expand", None}
433447
If `mode` is set to ``"expand"`` the legend will be horizontally
434448
expanded to fill the axes area (or `bbox_to_anchor` if defines

0 commit comments

Comments
 (0)