Skip to content

Commit 5f979de

Browse files
committed
Document new (and some old) kwargs in Figure.legend
1 parent aa857ad commit 5f979de

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

lib/matplotlib/figure.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1206,12 +1206,36 @@ def legend(self, handles, labels, *args, **kwargs):
12061206
if *False*, legend marker is placed to the right of the legend
12071207
label
12081208
1209+
*frameon*: [ *None* | bool ]
1210+
Control whether the legend should be drawn on a patch (frame).
1211+
Default is *None* which will take the value from the
1212+
``legend.frameon`` :data:`rcParam<matplotlib.rcParams>`.
1213+
12091214
*fancybox*: [ *None* | *False* | *True* ]
12101215
if *True*, draw a frame with a round fancybox. If *None*, use rc
12111216
12121217
*shadow*: [ *None* | *False* | *True* ]
12131218
If *True*, draw a shadow behind legend. If *None*, use rc settings.
12141219
1220+
*framealpha*: [ *None* | float ]
1221+
Control the alpha transparency of the legend's background.
1222+
Default is *None* which will take the value from the
1223+
``legend.framealpha`` :data:`rcParam<matplotlib.rcParams>`.
1224+
1225+
*facecolor*: [ *None* | "inherit" | a color spec ]
1226+
Control the legend's background color.
1227+
Default is *None* which will take the value from the
1228+
``legend.facecolor`` :data:`rcParam<matplotlib.rcParams>`.
1229+
If ``"inherit"``, it will take the ``axes.facecolor``
1230+
:data:`rcParam<matplotlib.rcParams>`.
1231+
1232+
*edgecolor*: [ *None* | "inherit" | a color spec ]
1233+
Control the legend's background patch edge color.
1234+
Default is *None* which will take the value from the
1235+
``legend.edgecolor`` :data:`rcParam<matplotlib.rcParams>`.
1236+
If ``"inherit"``, it will take the ``axes.edgecolor``
1237+
:data:`rcParam<matplotlib.rcParams>`.
1238+
12151239
*ncol* : integer
12161240
number of columns. default is 1
12171241

0 commit comments

Comments
 (0)