X Tutup
Skip to content

Clarify wspace/hspace in documentation/comments #7399

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
NelleV merged 2 commits into from
Nov 4, 2016
Merged

Clarify wspace/hspace in documentation/comments #7399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0507459
Clarify wspace/hspace in documentation/comments
stilley2 Nov 4, 2016
88ee53c
Remove astriks from keword arg doc strings
stilley2 Nov 4, 2016
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
6 changes: 4 additions & 2 deletions doc/faq/howto_faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,11 @@ The other parameters you can configure are, with their defaults
*top* = 0.9
the top of the subplots of the figure
*wspace* = 0.2
the amount of width reserved for blank space between subplots
the amount of width reserved for blank space between subplots,
expressed as a fraction of the average axis width
*hspace* = 0.2
the amount of height reserved for white space between subplots
the amount of height reserved for white space between subplots,
expressed as a fraction of the average axis height

If you want additional control, you can create an
:class:`~matplotlib.axes.Axes` using the
Expand Down
62 changes: 32 additions & 30 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,23 +169,25 @@ def __init__(self, left=None, bottom=None, right=None, top=None,

The following attributes are available

*left* : 0.125
left : 0.125
The left side of the subplots of the figure

*right* : 0.9
right : 0.9
The right side of the subplots of the figure

*bottom* : 0.1
bottom : 0.1
The bottom of the subplots of the figure

*top* : 0.9
top : 0.9
The top of the subplots of the figure

*wspace* : 0.2
The amount of width reserved for blank space between subplots
wspace : 0.2
The amount of width reserved for blank space between subplots,
expressed as a fraction of the average axis width

*hspace* : 0.2
The amount of height reserved for white space between subplots
hspace : 0.2
The amount of height reserved for white space between subplots,
expressed as a fraction of the average axis height
"""

self.validate = True
Expand Down Expand Up @@ -511,16 +513,16 @@ def suptitle(self, t, **kwargs):
kwargs are :class:`matplotlib.text.Text` properties. Using figure
coordinates, the defaults are:

*x* : 0.5
x : 0.5
The x location of the text in figure coords

*y* : 0.98
y : 0.98
The y location of the text in figure coords

*horizontalalignment* : 'center'
horizontalalignment : 'center'
The horizontal alignment of the text

*verticalalignment* : 'top'
verticalalignment : 'top'
The vertical alignment of the text

If the `fontproperties` keyword argument is given then the
Expand Down Expand Up @@ -1314,67 +1316,67 @@ def legend(self, handles, labels, *args, **kwargs):

Keyword arguments:

*prop*: [ *None* | FontProperties | dict ]
prop: [ *None* | FontProperties | dict ]
A :class:`matplotlib.font_manager.FontProperties`
instance. If *prop* is a dictionary, a new instance will be
created with *prop*. If *None*, use rc settings.

*numpoints*: integer
numpoints: integer
The number of points in the legend line, default is 4

*scatterpoints*: integer
scatterpoints: integer
The number of points in the legend line, default is 4

*scatteryoffsets*: list of floats
scatteryoffsets: list of floats
a list of yoffsets for scatter symbols in legend

*markerscale*: [ *None* | scalar ]
markerscale: [ *None* | scalar ]
The relative size of legend markers vs. original. If *None*, use rc
settings.

*markerfirst*: [ *True* | *False* ]
markerfirst: [ *True* | *False* ]
if *True*, legend marker is placed to the left of the legend label
if *False*, legend marker is placed to the right of the legend
label

*frameon*: [ *None* | bool ]
frameon: [ *None* | bool ]
Control whether the legend should be drawn on a patch (frame).
Default is *None* which will take the value from the
``legend.frameon`` :data:`rcParam<matplotlib.rcParams>`.

*fancybox*: [ *None* | *False* | *True* ]
fancybox: [ *None* | *False* | *True* ]
if *True*, draw a frame with a round fancybox. If *None*, use rc

*shadow*: [ *None* | *False* | *True* ]
shadow: [ *None* | *False* | *True* ]
If *True*, draw a shadow behind legend. If *None*, use rc settings.

*framealpha*: [ *None* | float ]
framealpha: [ *None* | float ]
Control the alpha transparency of the legend's background.
Default is *None* which will take the value from the
``legend.framealpha`` :data:`rcParam<matplotlib.rcParams>`.

*facecolor*: [ *None* | "inherit" | a color spec ]
facecolor: [ *None* | "inherit" | a color spec ]
Control the legend's background color.
Default is *None* which will take the value from the
``legend.facecolor`` :data:`rcParam<matplotlib.rcParams>`.
If ``"inherit"``, it will take the ``axes.facecolor``
:data:`rcParam<matplotlib.rcParams>`.

*edgecolor*: [ *None* | "inherit" | a color spec ]
edgecolor: [ *None* | "inherit" | a color spec ]
Control the legend's background patch edge color.
Default is *None* which will take the value from the
``legend.edgecolor`` :data:`rcParam<matplotlib.rcParams>`.
If ``"inherit"``, it will take the ``axes.edgecolor``
:data:`rcParam<matplotlib.rcParams>`.

*ncol* : integer
ncol : integer
number of columns. default is 1

*mode* : [ "expand" | *None* ]
mode : [ "expand" | *None* ]
if mode is "expand", the legend will be horizontally expanded
to fill the axes area (or *bbox_to_anchor*)

*title* : string
title : string
the legend title

Padding and spacing between various elements use following keywords
Expand Down Expand Up @@ -1838,13 +1840,13 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None,

Parameters:

*pad* : float
pad : float
padding between the figure edge and the edges of subplots,
as a fraction of the font-size.
*h_pad*, *w_pad* : float
h_pad, w_pad : float
padding (height/width) between edges of adjacent subplots.
Defaults to `pad_inches`.
*rect* : if rect is given, it is interpreted as a rectangle
rect : if rect is given, it is interpreted as a rectangle
(left, bottom, right, top) in the normalized figure
coordinate that the whole subplots area (including
labels) will fit into. Default is (0, 0, 1, 1).
Expand Down
6 changes: 4 additions & 2 deletions lib/matplotlib/mpl-data/stylelib/classic.mplstyle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,10 @@ figure.subplot.left : 0.125 # the left side of the subplots of the figure
figure.subplot.right : 0.9 # the right side of the subplots of the figure
figure.subplot.bottom : 0.1 # the bottom of the subplots of the figure
figure.subplot.top : 0.9 # the top of the subplots of the figure
figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots
figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots
figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots,
# expressed as a fraction of the average axis width
figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots,
# expressed as a fraction of the average axis height

### IMAGES
image.aspect : equal # equal | auto | a number
Expand Down
6 changes: 4 additions & 2 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,8 +1242,10 @@ def subplots_adjust(*args, **kwargs):
right = 0.9 # the right side of the subplots of the figure
bottom = 0.1 # the bottom of the subplots of the figure
top = 0.9 # the top of the subplots of the figure
wspace = 0.2 # the amount of width reserved for blank space between subplots
hspace = 0.2 # the amount of height reserved for white space between subplots
wspace = 0.2 # the amount of width reserved for blank space between subplots,
# expressed as a fraction of the average axis width
hspace = 0.2 # the amount of height reserved for white space between subplots,
# expressed as a fraction of the average axis height

The actual defaults are controlled by the rc file
"""
Expand Down
6 changes: 4 additions & 2 deletions matplotlibrc.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,8 +449,10 @@ backend : $TEMPLATE_BACKEND
#figure.subplot.right : 0.9 # the right side of the subplots of the figure
#figure.subplot.bottom : 0.11 # the bottom of the subplots of the figure
#figure.subplot.top : 0.88 # the top of the subplots of the figure
#figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots
#figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots
#figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots,
# expressed as a fraction of the average axis width
#figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots,
# expressed as a fraction of the average axis height


### IMAGES
Expand Down
X Tutup