Return a figure and a single subplot. This command is analogous to matplotlib.pyplot.subplot, except the figure instance is also returned.
refnum (int, optional) – The reference subplot number. The refwidth, refheight, and refaspect keyword args are applied to this subplot, and the aspect ratio is conserved for this subplot in the auto_layout. The default is the first subplot created in the figure.
refaspect (float or 2-tuple of float, optional) – The reference subplot aspect ratio. If scalar, this indicates the width divided by height. If 2-tuple, this indicates the (width, height). Ignored if both figwidth and figheight or both refwidth and refheight were passed. The default value is 1 or the “data aspect ratio” if the latter is explicitly fixed (as with imshow plots and GeoAxes projections; see set_aspect()).
refwidth, refheight (unit-spec, default: rc['subplots.refwidth'] = 2.5) – The width, height of the reference subplot. If float, units are inches. If string, interpreted by units. Ignored if figwidth, figheight, or figsize was passed. If you specify just one, refaspect will be respected.
ref, aspect, axwidth, axheight – Aliases for refnum, refaspect, refwidth, refheight. These may be deprecated in a future release.
figwidth, figheight (unit-spec, optional) – The figure width and height. Default behavior is to use refwidth. If float, units are inches. If string, interpreted by units. If you specify just one, refaspect will be respected.
width, height – Aliases for figwidth, figheight.
figsize (2-tuple, optional) – Tuple specifying the figure (width, height).
sharex, sharey, share ({0, False, 1, 'labels', 'labs', 2, 'limits', 'lims', 3, True, 4, 'all'}, default: rc['subplots.share'] = True) – The axis sharing “level” for the x axis, y axis, or both axes. Options are as follows:
0 or False: No axis sharing. This also sets the default spanx and spany values to False.
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, scales, and tick locations to be identical. Tick labels still appear on every subplot.
3 or True: As above but only show the tick labels on the bottommost row and leftmost column of subplots.
4 or 'all': As above but also share the axis limits, scales, and tick locations between subplots not in the same row or column.
spanx, spany, span (bool or {0, 1}, default: rc['subplots.span'] = True) – Whether to use “spanning” axis labels for the x axis, y axis, or both axes. Default is False if sharex, sharey, or share are 0 or False. When True, 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 and spany == True, your figure will have 1 y axis label instead of 9 y axis labels.
alignx, aligny, align (bool or {0, 1}, default: rc['subplots.align'] = False) – 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 is ignored if spanx, spany, or span are True.
left, right, top, bottom (unit-spec, default: None) – The fixed space between the subplots and the figure edge. If float, units are em-widths. If string, interpreted by units. If None, the space is determined automatically based on the tick and label settings. If rc['subplots.tight'] is True or tight=True was passed to the figure, the space is determined by the tight layout algorithm.
wspace, hspace, space (unit-spec, default: None) – The fixed space between grid columns, rows, or both. If float, units are em-widths. If string, interpreted by units. If None, the space is determined automatically based on the font size and axis sharing settings. If rc['subplots.tight'] is True or tight=True was passed to the figure, the space is determined by the tight layout algorithm.
tight (bool, default: :rc`subplots.tight`) – Whether automatic calls to auto_layout should include tight layout adjustments. If you manually specified a spacing in the call to subplots, it will be used to override the tight layout spacing. For example, with left=1, the left margin is set to 1 em-width, while the remaining margin widths are calculated automatically.
wequal, hequal, equal (bool, default: rc['subplots.equalspace'] = False) – Whether to make the tight layout algorithm apply equal spacing between columns, rows, or both.
wgroup, hgroup, group (bool, default: rc['subplots.groupspace'] = True) – Whether to make the tight layout algorithm just consider spaces between adjacent subplots instead of entire columns and rows of subplots.
outerpad (unit-spec, default: rc['subplots.outerpad'] = 0.5) – The scalar tight layout padding around the left, right, top, bottom figure edges. If float, units are em-widths. If string, interpreted by units.
innerpad (unit-spec, default: rc['subplots.innerpad'] = 1.0) – The scalar tight layout padding between columns and rows. Synonymous with pad. If float, units are em-widths. If string, interpreted by units.
panelpad (unit-spec, default: rc['subplots.panelpad'] = 0.5) – The scalar tight layout padding between subplots and their panels, colorbars, and legends and between “stacks” of these objects. If float, units are em-widths. If string, interpreted by units.
journal (str, optional) – String corresponding to an academic journal standard used to control the figure width figwidth and, if specified, the figure height figheight. See the below table. Feel free to add to this table by submitting a pull request.
**kwargs – Passed to ultraplot.figure.Figure.format or the projection-specific format command for the axes.
fig (ultraplot.figure.Figure) – The figure instance.
ax (ultraplot.axes.Axes) – The axes instance.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4