SubplotGrid.format¶

SubplotGrid.format(**kwargs)[source]¶

Call the format command for every axes in the grid.

Parameters

title (str, optional) – The axes title.
abc (bool or str, optional) – The “a-b-c” subplot label style. Must contain the character a or A, for example 'a.', or 'A'. If True then the default style of 'a' is used. The a or A is replaced with the alphabetic character matching the number. If number is greater than 26, the characters loop around to a, …, z, aa, …, zz, aaa, …, zzz, etc.

abcloc, titleloc (str, optional) – Strings indicating the location for the a-b-c label and main title. The following locations are valid (defaults are rc['abc.loc'] = 'left' and rc['title.loc'] = 'center'):

Location	Valid keys
center above axes	`'center'`, `'c'`
left above axes	`'left'`, `'l'`
right above axes	`'right'`, `'r'`
lower center inside axes	`'lower center'`, `'lc'`
upper center inside axes	`'upper center'`, `'uc'`
upper right inside axes	`'upper right'`, `'ur'`
upper left inside axes	`'upper left'`, `'ul'`
lower left inside axes	`'lower left'`, `'ll'`
lower right inside axes	`'lower right'`, `'lr'`

abcborder, titleborder (bool, optional) – Whether to draw a white border around titles and a-b-c labels positioned inside the axes. This can help them stand out on top of artists plotted inside the axes. Defaults are rc['abc.border'] = True and rc['title.border'] = True.
abcbbox, titlebbox (bool, optional) – Whether to draw a white bbox around titles and a-b-c labels positioned inside the axes. This can help them stand out on top of artists plotted inside the axes. Defaults are rc['abc.bbox'] = False and rc['title.bbox'] = False.
abc_kw, title_kw (dict-like, optional) – Additional settings used to update the a-b-c label and title with text.update().
titlepad (float, optional) – The padding for the inner and outer titles and a-b-c labels in arbitrary units (default is points). Default is rc['title.pad'] = 5.0.
titleabove (bool, optional) – Whether to try to put outer titles and a-b-c labels above panels, colorbars, or legends that are above the axes. Default is rc['title.above'] = True.
abctitlepad (float, optional) – The horizontal padding between the a-b-c label and title when they are in the same location. Default is rc['abc.titlepad'] = 4.0.
ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle (str, optional) – Shorthands for the below keywords.
lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle, lowerlefttitle, lowercentertitle, lowerrighttitle (str, optoinal) – Additional titles in specific positions. This works as an alternative to the ax.format(title='Title', titleloc=loc) workflow and permits adding more than one title-like label for a single axes.
a, alpha, fc, facecolor, ec, edgecolor, lw, linewidth, ls, linestyle (optional) – Additional settings applied to the background patch, and their shorthands. Defaults are rc['axes.alpha'], rc['axes.facecolor'], rc['axes.edgecolor'], rc['axes.linewidth'], and '-', respectively.
**kwargs – Passed to the projection-specific format command for each axes. Valid only if every axes in the grid belongs to the same class.

Other Parameters

rowlabels, collabels, llabels, tlabels, rlabels, blabels – Aliases for leftlabels and toplabels, and for leftlabels, toplabels, rightlabels, and bottomlabels, respectively.
leftlabels, toplabels, rightlabels, bottomlabels (sequence of str, optional) – Labels for the subplots lying along the left, top, right, and bottom edges of the figure. The length of each list must match the number of subplots along the corresponding edge.
leftlabelpad, toplabelpad, rightlabelpad, bottomlabelpad (float, optional) – The padding between the labels and the axes content in arbitrary units (default is points). Defaults are rc['leftlabel.pad'], rc['toplabel.pad'], rc['rightlabel.pad'], and rc['bottomlabel.pad']
leftlabels_kw, toplabels_kw, rightlabels_kw, bottomlabels_kw (dict-like, optional) – Additional settings used to update the labels with text.update().
figtitle – Alias for suptitle.
suptitle (str, optional) – The figure “super” title, centered between the left edge of the lefmost column of subplots and the right edge of the rightmost column of subplots, and automatically offset above figure titles. This is an improvement on matplotlib’s “super” title, which just centers the text between figure edges.
suptitlepad (float, optional) – The padding between the super title and the axes content in arbitrary units (default is points). Default is rc['suptitle.pad'].
suptitle_kw (optional) – Additional settings used to update the super title with text.update().
includepanels (bool, optional) – Whether to include panels when aligning figure “super titles” along the top of the subplot grid and when aligning the spanx x axis labels and spany y axis labels along the sides of the subplot grid. Default is False.
mathtext_fallback (bool or str, optional) – Apply this rc['mathtext.fallback'] value when drawing the figure. If True 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.
aspect ({'auto', 'equal'} or float, optional) – The data aspect ratio. See set_aspect for details.
xlabel, ylabel (str, optional) – The x and y axis labels. Applied with set_xlabel and set_ylabel.
xlabel_kw, ylabel_kw (dict-like, optional) – Additional axis label settings applied with set_xlabel and set_ylabel. See also labelpad, labelcolor, labelsize, and labelweight below.
xlim, ylim (2-tuple of floats or None, optional) – The x and y axis data limits. Applied with set_xlim and set_ylim.
xmin, ymin (float, optional) – The x and y minimum data limits. Useful if you do not want to set the maximum limits.
xmax, ymax (float, optional) – The x and y maximum data limits. Useful if you do not want to set the minimum limits.
xreverse, yreverse (bool, optional) – Whether to “reverse” the x and y axis direction. Makes the x and y axes ascend left-to-right and top-to-bottom, respectively.
xscale, yscale (scale-spec, optional) – The x and y axis scales. Passed to the Scale constructor. For example, xscale='log' applies logarithmic scaling, and xscale=('cutoff', 100, 2) applies a CutoffScale.
xscale_kw, yscale_kw (dict-like, optional) – The x and y axis scale settings. Passed to Scale.
xmargin, ymargin, margin (float, optional) – The default margin between plotted content and the x and y axis spines in axes-relative coordinates. Use this to add whitespace between plotted content and axes edges without explicitly setting the limits. Use margin to set both at once.
xbounds, ybounds (2-tuple of float, optional) – The x and y axis data bounds within which to draw the spines. For example, xlim=(0, 4) combined with xbounds=(2, 4) will prevent the spines from meeting at the origin. This also applies xspineloc='bottom' and yspineloc='left' by default if both spines are currently visible.
xtickrange, ytickrange (2-tuple of float, optional) – The x and y axis data ranges within which major tick marks are labelled. For example, xlim=(-5, 5) combined with xtickrange=(-1, 1) and a tick interval of 1 will only label the ticks marks at -1, 0, and 1. See AutoFormatter for details.
xwraprange, ywraprange (2-tuple of float, optional) – The x and y axis data ranges with which major tick mark values are wrapped. For example, xwraprange=(0, 3) causes the values 0 through 9 to be formatted as 0, 1, 2, 0, 1, 2, 0, 1, 2, 0. See AutoFormatter for details. This can be combined with xtickrange and ytickrange to make “stacked” line plots.
xloc, yloc (optional) – Shorthands for xspineloc, yspineloc.
xspineloc, yspineloc ({'bottom', 'top', 'left', 'right', 'both', 'neither', 'none', 'zero', 'center'} or 2-tuple, optional) – The x and y spine locations. Applied with set_position. Propagates to tickloc unless specified otherwise.
xtickloc, ytickloc ({'bottom', 'top', 'left', 'right', 'both', 'neither', 'none'}, optional) – Which x and y axis spines should have major and minor tick marks. Inherits from spineloc by default and propagates to ticklabelloc unless specified otherwise.
xticklabelloc, yticklabelloc ({'bottom', 'top', 'left', 'right', 'both', 'neither', 'none'}, optional) – Which x and y axis spines should have major tick labels. Inherits from tickloc by default and propagates to labelloc and offsetloc unless specified otherwise.
xlabelloc, ylabelloc ({'bottom', 'top', 'left', 'right'}, optional) – Which x and y axis spines should have axis labels. Inherits from ticklabelloc by default (if ticklabelloc is a single side).
xoffsetloc, yoffsetloc ({'left', 'right'}, optional) – Which x and y axis spines should have the axis offset indicator. Inherits from ticklabelloc by default (if ticklabelloc is a single side).
xtickdir, ytickdir, tickdir ({'out', 'in', 'inout'}) – Direction that major and minor tick marks point for the x and y axis. Default is rc['tick.dir'] = 'out'. Use tickdir to control both.
xticklabeldir, yticklabeldir ({'in', 'out'}) – Whether to place x and y axis tick label text inside or outside the axes. Propagates to xtickdir and ytickdir unless specified otherwise.
xrotation, yrotation (float, optional) – The rotation for x and y axis tick labels. Default is 0 for normal axes, rc['formatter.timerotation'] = 'vertical' for time x axes.
xgrid, ygrid, grid (bool, optional) – Whether to draw major gridlines on the x and y axis. Use grid to toggle both.
xgridminor, ygridminor, gridminor (bool, optional) – Whether to draw minor gridlines for the x and y axis. Use gridminor to toggle both.
xtickminor, ytickminor, tickminor (bool, optional) – Whether to draw minor ticks on the x and y axes. Use tickminor to toggle both.
xticks, yticks (optional) – Aliases for xlocator, ylocator.
xlocator, ylocator (locator-spec, optional) – Used to determine the x and y axis tick mark positions. Passed to the Locator constructor. Can be float, list of float, string, or matplotlib.ticker.Locator instance. Use [], 'null', or 'none' for no ticks.
xlocator_kw, ylocator_kw (dict-like, optional) – Keyword arguments passed to the matplotlib.ticker.Locator class.
xminorticks, yminorticks (optional) – Aliases for xminorlocator, yminorlocator.
xminorlocator, yminorlocator (optional) – As for xlocator, ylocator, but for the minor ticks.
xminorlocator_kw, yminorlocator_kw – As for xlocator_kw, ylocator_kw, but for the minor locator.
xticklabels, yticklabels (optional) – Aliases for xformatter, yformatter.
xformatter, yformatter (formatter-spec, optional) – Used to determine the x and y axis tick label string format. Passed to the Formatter constructor. Can be string, list of strings, or matplotlib.ticker.Formatter instance. Use [], 'null', or 'none' for no labels.
xformatter_kw, yformatter_kw (dict-like, optional) – Keyword arguments passed to the matplotlib.ticker.Formatter class.
xcolor, ycolor, color (color-spec, optional) – Color for the x and y axis spines, ticks, tick labels, and axis labels. Use color to set both at once.
xgridcolor, ygridcolor, gridcolor (color-spec, optional) – Color for the x and y axis major and minor gridlines. Default is rc['grid.color'] = 'black'. Use gridcolor to set both at once.
xlinewidth, ylinewidth, linewidth (color-spec, optional) – Line width for the x and y axis spines and major ticks. Propagates to tickwidth unless specified otherwise. Use linewidth to set both at once.
xtickcolor, ytickcolor, tickcolor (color-spec, optional) – Color for the x and y axis ticks. Default is xcolor, ycolor, and color or rc['tick.color'] = 'black' if they were not passed. Use tickcolor to set both at once.
xticklen, yticklen, ticklen (unit-spec, optional) – Major tick lengths for the x and y axis. Default is rc['tick.len'] = 4.0. If float, units are points. If string, interpreted by units. Use ticklen to set both at once.
xticklenratio, yticklenratio, ticklenratio (float, optional) – Relative scaling of xticklen and yticklen used to determine minor tick lengths. Default is rc['tick.lenratio'] = 0.5. Use ticklenratio to set both at once.
xtickwidth, ytickwidth, tickwidth, (unit-spec, optional) – Major tick widths for the x ans y axis. Default is linewidth or rc['tick.width'] = 0.6 if linewidth was not passed. If float, units are points. If string, interpreted by units. Use tickwidth to set both at once.
xtickwidthratio, ytickwidthratio, tickwidthratio – Relative scaling of xtickwidth and ytickwidth used to determine minor tick widths. Default is rc['tick.widthratio'] = 0.8. Use tickwidthratio to set both at once.
xticklabelpad, yticklabelpad (unit-spec, optional) – The padding between the x and y axis ticks and tick labels. Default is rc['tick.labelpad']. If float, units are points. If string, interpreted by units.
xticklabelcolor, yticklabelcolor, ticklabelcolor (color-spec, optional) – Color for the x and y tick labels. Default is xcolor, ycolor, and color or rc['tick.labelcolor'] = 'black' if they were not passed. Use ticklabelcolor to set both.
xticklabelsize, yticklabelsize, ticklabelsize (unit-spec or str, optional) – Font size for the x and y tick labels. Default is rc['tick.labelsize'] = 'medium'. If float, units are points. If string, interpreted by units. Use ticklabelsize to set both at once.
xticklabelweight, yticklabelweight, ticklabelweight (str, optional) – Font weight for the x and y axis labels. Default is rc['label.weight'] = 'normal'. Use ticklabelweight to set both at once.
xlabelpad, ylabelpad (unit-spec, optional) – The padding between the x and y axis bounding box and the x and y axis labels. Default is rc['label.pad'] = 4.0. If float, units are points. If string, interpreted by units.
xlabelcolor, ylabelcolor, labelcolor (color-spec, optional) – Color for the x and y axis labels. Default is xcolor, ycolor, and color or rc['label.color'] = 'black' if they were not passed. Use labelcolor to set both at once.
xlabelsize, ylabelsize, labelsize (unit-spec or str, optional) – Font size for the x and y axis labels. Default is rc['label.size'] = 'medium'. If float, units are points. If string, interpreted by units. Use labelsize to set both at once.
xlabelweight, ylabelweight, labelweight (str, optional) – Font weight for the x and y axis labels. Default is rc['label.weight'] = 'normal'. Use labelweight to set both at once.
fixticks (bool, optional) – Whether to always transform the tick locators to a FixedLocator instance. Default is False. If your axis ticks are doing weird things (for example, ticks drawn outside of the axis spine), try setting this to True.
r0 (float, optional) – The radial origin. Default is 0.
theta0 ({'N', 'NW', 'W', 'SW', 'S', 'SE', 'E', 'NE'}) – The zero azimuth location. Default is N.
thetadir ({1, -1, 'anticlockwise', 'counterclockwise', 'clockwise'}, optional) – The positive azimuth direction. Clockwise corresponds to -1 and anticlockwise corresponds to 1. Default is 1.
thetamin, thetamax (float, optional) – The lower and upper azimuthal bounds in degrees. If thetamax != thetamin + 360, this produces a sector plot.
thetalim (2-tuple of float or None, optional) – Specifies thetamin and thetamax at once.
rmin, rmax (float, optional) – The inner and outer radial limits. If r0 != rmin, this produces an annular plot.
rlim (2-tuple of float or None, optional) – Specifies rmin and rmax at once.
rborder (bool, optional) – Whether to draw the polar axes border. Visibility of the “inner” radial spine and “start” and “end” azimuthal spines is controlled automatically by matplotlib.
thetagrid, rgrid, grid (bool, optional) – Whether to draw major gridlines for the azimuthal and radial axis. Use grid to toggle both.
thetagridminor, rgridminor, gridminor (bool, optional) – Whether to draw minor gridlines for the azimuthal and radial axis. Use gridminor to toggle both.
thetagridcolor, rgridcolor, gridcolor (color-spec, optional) – Color for the major and minor azimuthal and radial gridlines. Use gridcolor to set both at once.
thetalocator, rlocator (locator-spec, optional) – Used to determine the azimuthal and radial gridline positions. Passed to the Locator constructor. Can be float, list of float, string, or matplotlib.ticker.Locator instance.
thetalines, rlines – Aliases for thetalocator, rlocator.
thetalocator_kw, rlocator_kw (dict-like, optional) – The azimuthal and radial locator settings. Passed to Locator.
thetaminorlocator, rminorlocator (optional) – As for thetalocator, rlocator, but for the minor gridlines.
thetaminorticks, rminorticks (optional) – Aliases for thetaminorlocator, rminorlocator.
thetaminorlocator_kw, rminorlocator_kw – As for thetalocator_kw, rlocator_kw, but for the minor locator.
rlabelpos (float, optional) – The azimuth at which radial coordinates are labeled.
thetaformatter, rformatter (formatter-spec, optional) – Used to determine the azimuthal and radial label format. Passed to the Formatter constructor. Can be string, list of string, or matplotlib.ticker.Formatter instance. Use [], 'null', or 'none' for no labels.
thetalabels, rlabels (optional) – Aliases for thetaformatter, rformatter.
thetaformatter_kw, rformatter_kw (dict-like, optional) – The azimuthal and radial label formatter settings. Passed to Formatter.
color (color-spec, optional) – Color for the axes edge. Propagates to labelcolor unless specified otherwise (similar to proplot.axes.CartesianAxes.format).
labelcolor, gridlabelcolor (color-spec, optional) – Color for the gridline labels. Default is color or rc['grid.labelcolor'] = 'black' if color was not passed.
labelpad, gridlabelpad (unit-spec, optional) – The padding between the axes edge and the radial and azimuthal labels. Default is rc['grid.labelpad']. If float, units are points. If string, interpreted by units.
labelsize, gridlabelsize (unit-spec or str, optional) – Font size for the gridline labels. Default is rc['grid.labelsize'] = 'medium'. If float, units are points. If string, interpreted by units.
labelweight, gridlabelweight (str, optional) – Font weight for the gridline labels. Default is rc['grid.labelweight'] = 'normal'.
lonlim, latlim (2-tuple of float, optional) – For cartopy axes only. The approximate longitude and latitude boundaries of the map, applied with set_extent. Basemap axes extents must be declared by passing keyword arguments to Proj.
boundinglat (float, optional) – For cartopy axes only. The edge latitude for the circle bounding North Pole and South Pole-centered projections. Basemap bounding latitudes must be declared by passing keyword arguments to Proj.
longrid, latgrid (bool, optional) – Whether to draw longitude and latitude gridlines. Default is rc.grid = True. Use grid to toggle both.
longridminor, latgridminor (bool, optional) – Whether to draw “minor” longitude and latitude lines. Default is rc.gridminor = False. Use gridminor to toggle both.
lonlines, latlines (optional) – Aliases for lonlocator, latlocator.
lonlocator, latlocator (locator-spec, optional) – Used to determine the longitude and latitude gridline locations. Passed to the Locator constructor. Can be string, float, list of float, or matplotlib.ticker.Locator instance.

For basemap or cartopy < 0.18, the defaults are 'deglon' and 'deglat', which correspond to the LongitudeLocator and LatitudeLocator locators (adapted from cartopy). For cartopy >= 0.18, the defaults are 'dmslon' and 'dmslat', which uses the same locators with dms=True. This selects gridlines at nice degree-minute-second intervals when the map extent is very small.
lonlines_kw, latlines_kw (optional) – Aliases for lonlocator_kw, latlocator_kw.
lonlocator_kw, latlocator_kw (dict-like, optional) – Keyword arguments passed to the matplotlib.ticker.Locator class.
lonminorlocator, latminorlocator, lonminorlines, latminorlines (optional) – As with lonlocator and latlocator but for the “minor” gridlines. The defaults are rc['grid.lonminorstep'] and rc['grid.latminorstep'].
lonminorlines_kw, latminorlines_kw (optional) – Aliases for lonminorlocator_kw, latminorlocator_kw.
lonminorlocator_kw, latminorlocator_kw (optional) – As with lonlocator_kw and latlocator_kw but for the “minor” gridlines.
latmax (float, optional) – The maximum absolute latitude for longitude and latitude gridlines. Longitude gridlines are cut off poleward of this latitude for all basemap projections and cartopy projections predating cartopy 0.18. Default is 80.
labels (bool, optional) – Sets lonlabels and latlabels to True. Default is rc['grid.labels'] = False. To draw labels by default use e.g. pplt.rc['grid.labels'] = True.
lonlabels, latlabels (optional) – Whether to label longitudes and latitudes, and on which sides of the map. There are four different options:
1. Boolean True. Indicates the left side for latitudes, bottom side for longitudes.
2. A string or tuple of strings indicating the side names, e.g. 'left' for latitudes or 'bottom' for longitudes.
3. A string indicating the side names with single characters, e.g. 'lr' for latitudes or 'bt' for longitudes.
4. A boolean 2-tuple indicating whether to draw labels on the (left, right) sides for latitudes, or (bottom, top) sides for longitudes.
5. A boolean 4-tuple indicating whether to draw labels on the (left, right, bottom, top) sides, as with the basemap drawmeridians and drawparallels labels keyword.
lonformatter, latformatter (formatter-spec, optional) – Formatter used to style longitude and latitude gridline labels. Passed to the Formatter constructor. Can be string, list of string, or matplotlib.ticker.Formatter instance.

For basemap or cartopy < 0.18, the defaults are 'deglon' and 'deglat', which correspond to SimpleFormatter presets with degree symbols and cardinal direction suffixes. For cartopy >= 0.18, the defaults are 'dmslon' and 'dmslat', which uses cartopy’s LongitudeFormatter and LatitudeFormatter formatters with dms=True. This formats gridlines that do not fall on whole degrees as “minutes” and “seconds” rather than decimal degrees.
lonformatter_kw, latformatter_kw (dict-like, optional) – Keyword arguments passed to the matplotlib.ticker.Formatter class.
loninline, latinline, inlinelabels (bool, optional) – For cartopy axes only. Whether to draw inline longitude and latitude gridline labels. Default is rc['grid.inlinelabels'] = False. Setting these to True also sets the default values for lonlabels, latlabels, and labels to True (respectively).
rotatelabels (bool, optional) – For cartopy axes only. Whether to rotate longitude and latitude gridline labels. Default is rc['grid.rotatelabels'] = False.
labelpad (unit-spec, optional) – For cartopy axes only. The padding between the map boundary and longitude and latitude gridline labels. Default is rc['grid.labelpad'] = 4.0. If float, units are points. If string, interpreted by units.
dms (bool, optional) – For cartopy axes only. Specifies whether the default locators and formatters should use “minutes” and “seconds” for gridline labels on small scales rather than decimal degrees. Setting this to False is equivalent to specifying ax.format(lonlocator='deglon', latlocator='deglon') and ax.format(lonformatter='deglon', latformatter='deglat'). Default is rc['grid.dmslabels'] = True.
nsteps (int, optional) – For cartopy axes only. The number of interpolation steps used to draw gridlines. Default is rc['grid.nsteps'] = 250.
land, ocean, coast, rivers, lakes, borders, innerborders (bool, optional) – Toggles various geographic features. These are actually the rc.land, rc.ocean, rc.coast, rc.rivers, rc.lakes, rc.borders, and rc.innerborders settings passed to context. The style can be modified using additional rc settings.

For example, to change rc['land.color'], use ax.format(landcolor='green'), and to change rc['land.zorder'], use ax.format(landzorder=4).
reso ({'lo', 'med', 'hi', 'x-hi', 'xx-hi'}, optional) – For cartopy axes only. The resolution of geographic features. For basemap axes, this must be passed to Proj.
color (color-spec, optional) – Color for the axes edge. Propagates to labelcolor unless specified otherwise (similar to proplot.axes.CartesianAxes.format).
labelcolor, gridlabelcolor (color-spec, optional) – Color for the grid labels. Default is color or rc['grid.labelcolor'] = 'black' if color was not passed.
labelsize, gridlabelsize (unit-spec or str, optional) – Font size for the gridline labels. Default is rc['grid.labelsize'] = 'medium'. If float, units are points. If string, interpreted by units.
labelweight, gridlabelweight (str, optional) – Font weight for the gridline labels. Default is rc['grid.labelweight'] = 'normal'.
rc_mode (int, optional) – The context mode passed to context.
rc_kw (dict-like, optional) – An alternative to passing extra keyword arguments. See below.
**kwargs – Keyword arguments that match the name of an rc setting are passed to proplot.config.Configurator.context and used to update the axes. If the setting name has “dots” you can simply omit the dots. For example, abc='A.' modifies the rc.abc setting, titleloc='left' modifies the rc['title.loc'] setting, gridminor=True modifies the rc.gridminor setting, and gridbelow=True modifies the rc['grid.below'] setting. Many of the keyword arguments documented above are internally applied by retrieving settings passed to context.