figure¶
- figure(*args, **kwargs)[source]¶
Create an empty figure. Subplots can be subsequently added using
add_subplot
orsubplots
. This command is analogous tomatplotlib.pyplot.figure
.- Parameters
refnum (
int
, optional) – The reference subplot number. Therefwidth
,refheight
, andrefaspect
keyword args are applied to this subplot, and the aspect ratio is conserved for this subplot in theauto_layout
. The default is the first subplot created in the figure.refaspect (
float
orlength-2 list
offloats
, optional) – The reference subplot aspect ratio. If scalar, this indicates the width divided by height. If 2-tuple, indicates the (width, height). Ignored if bothfigwidth
andfigheight
or bothrefwidth
andrefheight
were passed.refwidth, refheight (
float
orstr
, optional) – The width, height of the reference subplot. Default isrc['subplots.refwidth']
=2.5
. If float, units are inches. If string, interpreted byunits
. Ignored iffigwidth
,figheight
, orfigsize
was passed.ref, aspect, axwidth, axheight – Aliases for
refnum
,refaspect
,refwidth
,refheight
. These may be deprecated in a future release.figwidth, figheight (
float
orstr
, optional) – The figure width and height. If float, units are inches. If string, interpreted byunits
. If you specify just one, the aspect ratiorefaspect
of the reference subplot will be preserved.width, height – Aliases for
figwidth
,figheight
.figsize (
length-2 tuple
, optional) – Tuple specifying the figure(width, height)
.sharex, sharey, share (
{0, False, 1, 'labels', 'labs', 2, 'limits', 'lims', 3, True}
, optional) – The axis sharing “level” for the x axis, y axis, or both axes. Default isrc['subplots.share']
=True
. Options are as follows:0
orFalse
: No axis sharing. This also sets the defaultspanx
andspany
values toFalse
.1
or'labels'
or'labs'
: Only draw axis labels on the bottommost row or leftmost column of subplots. Tick labels still appear on every subplot.2
or'limits'
or'lims'
: As above but force the axis limits to be identical. Tick labels still appear on every subplot.3
orTrue
: As above but only show the tick labels on the bottommost row and leftmost column of subplots.
spanx, spany, span (
bool
or{0, 1}
, optional) – Whether to use “spanning” axis labels for the x axis, y axis, or both axes. Default isFalse
ifsharex
,sharey
, orshare
are0
orFalse
,rc['subplots.span']
=True
otherwise. WhenTrue
, a single, centered axis label is used for all axes with bottom and left edges in the same row or column. This can considerably redundancy in your figure.“Spanning” labels integrate with “shared” axes. For example, for a 3-row, 3-column figure, with
sharey > 1
andspany=1
, your figure will have 1 ylabel instead of 9.alignx, aligny, align (
bool
or{0, 1}
, optional) – Whether to “align” axis labels for the x axis, y axis, or both axes. Aligned labels always appear in the same row or column. This Only has an effect whenspanx
,spany
, orspan
areFalse
. Default isrc['subplots.align']
=False
.left, right, top, bottom (
float
orstr
, optional) – The fixed space between the subplots and the figure edge. Default isNone
. %(units.em)s IfNone
, the space is determined automatically based on the font size and axis sharing settings. Ifrc['subplots.tight']
isTrue
, the space is determined by the tight layout algorithm.wspace, hspace, space (
float
ortr
, optional) – The fixed space between grid columns, rows, or both. Default isNone
. %(units.em)s IfNone
, the space is determined automatically based on the font size and axis sharing settings. Ifrc['subplots.tight']
isTrue
, the space is determined by the tight layout algorithm.tight (
bool
, optional) – Whether to haveauto_layout
include tight layout adjustments. Default isrc['subplots.tight']
=True
. If you manually specified a spacing in the call tosubplots
, it will be used to override the tight layout spacing. For example, withleft=1
, the left margin is set to 1 em-width, while the remaining margin widths are calculated automatically.wequal, hequal, equal (
bool
, optional) – Whether to make the tight layout algorithm apply equal spacing between columns, rows, or both. Default isFalse
. Ignored ifrc.tight
isFalse
.outerpad (
float
orstr
, optional) – The tight layout padding around edge of figure. Units are interpreted byunits
. Default isrc['subplots.outerpad']
=0.5
. %(units.em)sinnerpad (
float
orstr
, optional) – The scalar tight layout padding between columns and rows. Synonymous withpad
. Default isrc['subplots.innerpad']
=1.0
. %(units.em)spanelpad (
float
orstr
, optional) – The tight layout padding between subplots and axes panels and between “stacked” panels. Default isrc['subplots.panelpad']
=0.5
. %(units.em)sincludepanels (
bool
, optional) – Whether to include panels when aligning figure “super titles” along the top of the subplot grid and when aligning thespanx
x axis labels andspany
y axis labels along the sides of the subplot grid. Default isFalse
.mathtext_fallback (
bool
orstr
, optional) – Apply thisrc['mathtext.fallback']
value when drawing the figure. IfTrue
or string, unavailable glyphs are replaced with a glyph from a fallback font (Computer Modern by default). Otherwise, they are replaced with the “¤” dummy character. For details see this mathtext tutorial.journal (
str
, optional) – String corresponding to an academic journal standard used to control the figure widthfigwidth
and, if specified, the figure heightfigheight
. See the below table. Feel free to add to this table by submitting a pull request.Key
Size description
Organization
'aaas1'
1-column
American Association for the Advancement of Science (e.g. Science)
'aaas2'
2-column
”
'agu1'
1-column
'agu2'
2-column
”
'agu3'
full height 1-column
”
'agu4'
full height 2-column
”
'ams1'
1-column
'ams2'
small 2-column
”
'ams3'
medium 2-column
”
'ams4'
full 2-column
”
'nat1'
1-column
'nat2'
2-column
”
'pnas1'
1-column
'pnas2'
2-column
”
'pnas3'
landscape page
”
- Other Parameters
**kwargs – Passed to
matplotlib.figure.Figure
.