GridSpec¶
- class GridSpec(nrows=1, ncols=1, **kwargs)[source]¶
Bases:
GridSpec
A
GridSpec
subclass that permits variable spacing between successive rows and columns and hides “panel slots” from indexing.- Parameters
- Other Parameters
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 byunits
. IfNone
, the space is determined automatically based on the tick and label settings. Ifrc['subplots.tight']
isTrue
ortight=True
was passed to the figure, the space is determined by the tight layout algorithm.wspace, hspace, space (
unit-spec
or sequence, default:None
) – The fixed space between grid columns, rows, and both, respectively. If float, string, orNone
, this value is expanded into lists of lengthncols - 1
(forwspace
) or lengthnrows - 1
(forhspace
). If a sequence, its length must match these lengths. If float, units are em-widths. If string, interpreted byunits
.For elements equal to
None
, the space is determined automatically based on the tick and label settings. Ifrc['subplots.tight']
isTrue
ortight=True
was passed to the figure, the space is determined by the tight layout algorithm. For example,subplots(ncols=3, tight=True, wspace=(2, None))
fixes the space between columns 1 and 2 but lets the tight layout algorithm determine the space between columns 2 and 3.wratios, hratios (
float
or sequence, optional) – Passed toGridSpec
, denotes the width and height ratios for the subplot grid. Length ofwratios
must match the number of columns, and length ofhratios
must match the number of rows.width_ratios, height_ratios – Aliases for
wratios
,hratios
. Included for consistency withmatplotlib.gridspec.GridSpec
.wpad, hpad, pad (
unit-spec
or sequence, optional) – The tight layout padding between columns, rows, and both, respectively. Unlikespace
, these control the padding between subplot content (including text, ticks, etc.) rather than subplot edges. As withspace
, these can be scalars or arrays optionally containingNone
. For elements equal toNone
, the default isinnerpad
. If float, units are em-widths. If string, interpreted byunits
.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 byunits
.innerpad (
unit-spec
, default:rc['subplots.innerpad']
=1.0
) – The scalar tight layout padding between columns and rows. Synonymous withpad
. If float, units are em-widths. If string, interpreted byunits
.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 byunits
.
See also
proplot.ui.figure
,proplot.figure.Figure
,proplot.ui.subplots
,proplot.figure.Figure.subplots
,proplot.figure.Figure.add_subplots
,matplotlib.gridspec.GridSpec
Important
Adding axes panels, axes or figure colorbars, and axes or figure legends quietly augments the gridspec geometry by inserting “panel slots”. However, subsequently indexing the gridspec with
gs[num]
orgs[row, col]
will ignore the “panel slots”. This permits adding new subplots by passinggs[num]
orgs[row, col]
toadd_subplot
even in the presence of panels (see__getitem__
for details). This also means that eachGridSpec
isFigure
-specific, i.e. it can only be used once (if you are working withGridSpec
instances manually and want the same geometry for multiple figures, you must create a copy withGridSpec.copy
before working on the subsequent figure).Attributes Summary
The
proplot.figure.Figure
uniquely associated with thisGridSpec
.Methods Summary
__getitem__
(key)Get a
SubplotSpec
.copy
(**kwargs)Return a copy of the
GridSpec
with theFigure
-specific "panel slots" removed.Return the number of "unhidden" non-panel rows and columns in the grid (see
GridSpec
for details).get_grid_positions
([figure])Return the subplot grid positions allowing for variable inter-subplot spacing and using physical units for the spacing terms.
Return the number of "hidden" panel rows and columns in the grid (see
GridSpec
for details).Return the total number of "unhidden" and "hidden" rows and columns in the grid (see
GridSpec
for details).update
(**kwargs)Update the gridspec with arbitrary initialization keyword arguments and update the subplot positions.