SubplotGrid

class SubplotGrid(sequence=None, **kwargs)[source]

Bases: MutableSequence, list

List-like, array-like object used to store subplots returned by subplots. 1D indexing uses the underlying list of Axes while 2D indexing uses the gridspec. See __getitem__ for details.

Parameters:: sequence (sequence) – A sequence of ultraplot.axes.Axes subplots or their children.

Attributes Summary

`figure`	The `ultraplot.figure.Figure` uniquely associated with this `SubplotGrid`.
`gridspec`	The `GridSpec` uniquely associated with this `SubplotGrid`.
`shape`	The shape of the `GridSpec` associated with the grid.

Methods Summary

`altx`(args, *kwargs)	Add an axis locked to the same location with a distinct x axis for every axes in the grid.
`alty`(args, *kwargs)	Add an axis locked to the same location with a distinct y axis for every axes in the grid.
`dualx`(args, *kwargs)	Add an axes locked to the same location whose x axis denotes equivalent coordinates in alternate units for every axes in the grid.
`dualy`(args, *kwargs)	Add an axes locked to the same location whose y axis denotes equivalent coordinates in alternate units for every axes in the grid.
`format`(**kwargs)	Call the `format` command for the `figure` and every axes in the grid.
`insert`(key, value)	S.insert(index, value) -- insert value before index
`inset`(args, *kwargs)	Add an inset axes for every axes in the grid.
`inset_axes`(args, *kwargs)
`panel`(args, *kwargs)	Add a panel axes for every axes in the grid.
`panel_axes`(args, *kwargs)
`share_labels`(*[, axis])	Register an explicit label-sharing group for this subset.
`twinx`(args, *kwargs)	Add an axis locked to the same location with a distinct y axis for every axes in the grid.
`twiny`(args, *kwargs)	Add an axis locked to the same location with a distinct x axis for every axes in the grid.

Attributes Documentation

figure: The ultraplot.figure.Figure uniquely associated with this SubplotGrid. This is used with the SubplotGrid.format command.

See also

ultraplot.gridspec.GridSpec.figure, ultraplot.gridspec.SubplotGrid.gridspec, ultraplot.figure.Figure.subplotgrid

gridspec: The GridSpec uniquely associated with this SubplotGrid. This is used to resolve 2D indexing. See __getitem__ for details.

See also

ultraplot.figure.Figure.gridspec, ultraplot.gridspec.SubplotGrid.figure, ultraplot.gridspec.SubplotGrid.shape

shape: The shape of the GridSpec associated with the grid. See __getitem__ for details.

See also

ultraplot.gridspec.SubplotGrid.gridspec

Methods Documentation

altx(*args, **kwargs) → SubplotGrid[source]

Add an axis locked to the same location with a distinct x axis for every axes in the grid. This is an alias and arguably more intuitive name for twiny, which generates two x axes with a shared (“twin”) y axes.

Parameters:: **kwargs – Passed to CartesianAxes. Supports all valid format keywords. You can optionally omit the x from keywords beginning with x – for example ax.altx(lim=(0, 10)) is equivalent to ax.altx(xlim=(0, 10)). You can also change the default side for the axis spine, axis tick marks, axis tick labels, and/or axis labels by passing loc keywords. For example, ax.altx(loc='bottom') changes the default side from top to bottom.
Returns:: SubplotGridultraplot.axes.CartesianAxesA grid of the resulting axes.

Note

This enforces the following default settings:

Places the old x axis on the bottom and the new x axis on the top.
Makes the old top spine invisible and the new bottom, left, and right spines invisible.
Adjusts the x axis tick, tick label, and axis label positions according to the visible spine positions.
Syncs the old and new y axis limits and scales, and makes the new y axis labels invisible.

alty(*args, **kwargs) → SubplotGrid[source]

Add an axis locked to the same location with a distinct y axis for every axes in the grid. This is an alias and arguably more intuitive name for twinx, which generates two y axes with a shared (“twin”) x axes.

Parameters:: **kwargs – Passed to CartesianAxes. Supports all valid format keywords. You can optionally omit the y from keywords beginning with y – for example ax.alty(lim=(0, 10)) is equivalent to ax.alty(ylim=(0, 10)). You can also change the default side for the axis spine, axis tick marks, axis tick labels, and/or axis labels by passing loc keywords. For example, ax.alty(loc='left') changes the default side from right to left.
Returns:: SubplotGridultraplot.axes.CartesianAxesA grid of the resulting axes.

Note

This enforces the following default settings:

Places the old y axis on the left and the new y axis on the right.
Makes the old right spine invisible and the new left, bottom, and top spines invisible.
Adjusts the y axis tick, tick label, and axis label positions according to the visible spine positions.
Syncs the old and new x axis limits and scales, and makes the new x axis labels invisible.

dualx(*args, **kwargs) → SubplotGrid[source]

Add an axes locked to the same location whose x axis denotes equivalent coordinates in alternate units for every axes in the grid. This is an alternative to matplotlib.axes.Axes.secondary_xaxis with additional convenience features.

Parameters:

funcscale (callable(), 2-tuple of callables, or scale-spec) – The scale used to transform units from the parent axis to the secondary axis. This can be a FuncScale itself or a function, (function, function) tuple, or an axis scale specification interpreted by the Scale constructor function, any of which will be used to build a FuncScale and applied to the dual axis (see FuncScale for details).
**kwargs – Passed to CartesianAxes. Supports all valid format keywords. You can optionally omit the x from keywords beginning with x – for example ax.altx(lim=(0, 10)) is equivalent to ax.altx(xlim=(0, 10)). You can also change the default side for the axis spine, axis tick marks, axis tick labels, and/or axis labels by passing loc keywords. For example, ax.altx(loc='bottom') changes the default side from top to bottom.

Returns:

SubplotGridultraplot.axes.CartesianAxesA grid of the resulting axes.

Note

This enforces the following default settings:

Places the old x axis on the bottom and the new x axis on the top.
Makes the old top spine invisible and the new bottom, left, and right spines invisible.
Adjusts the x axis tick, tick label, and axis label positions according to the visible spine positions.
Syncs the old and new y axis limits and scales, and makes the new y axis labels invisible.

dualy(*args, **kwargs) → SubplotGrid[source]

Add an axes locked to the same location whose y axis denotes equivalent coordinates in alternate units for every axes in the grid. This is an alternative to matplotlib.axes.Axes.secondary_yaxis with additional convenience features.

Parameters:

funcscale (callable(), 2-tuple of callables, or scale-spec) – The scale used to transform units from the parent axis to the secondary axis. This can be a FuncScale itself or a function, (function, function) tuple, or an axis scale specification interpreted by the Scale constructor function, any of which will be used to build a FuncScale and applied to the dual axis (see FuncScale for details).
**kwargs – Passed to CartesianAxes. Supports all valid format keywords. You can optionally omit the y from keywords beginning with y – for example ax.alty(lim=(0, 10)) is equivalent to ax.alty(ylim=(0, 10)). You can also change the default side for the axis spine, axis tick marks, axis tick labels, and/or axis labels by passing loc keywords. For example, ax.alty(loc='left') changes the default side from right to left.

Returns:

SubplotGridultraplot.axes.CartesianAxesA grid of the resulting axes.

Note

This enforces the following default settings:

Places the old y axis on the left and the new y axis on the right.
Makes the old right spine invisible and the new left, bottom, and top spines invisible.
Adjusts the y axis tick, tick label, and axis label positions according to the visible spine positions.
Syncs the old and new x axis limits and scales, and makes the new x axis labels invisible.

format(**kwargs)[source]

Call the format command for the figure and every axes in the grid.

Parameters:

title (str or sequence, optional) – The axes title. Can optionally be a sequence strings, in which case the title will be selected from the sequence according to number.
abc (bool or str or sequence, default: rc.abc = False) – 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. Can also be a sequence of strings, in which case the “a-b-c” label will be selected sequentially from the list. For example axs.format(abc = ["X", "Y"]) for a two-panel figure, and axes[3:5].format(abc = ["X", "Y"]) for a two-panel subset of a larger figure.

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

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'`
left of y axis	`'outer left'`, `'ol'`
right of y axis	`'outer right'`, `'or'`

abcborder, titleborder (bool, default: rc['abc.border'] = True and rc['title.border'] = True) – 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.
abcbbox, titlebbox (bool, default: rc['abc.bbox'] = False and rc['title.bbox'] = False) – 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.
abcpad (float or unit-spec, default: rc['abc.pad']) – Horizontal offset to shift the a-b-c label position. Positive values move the label right, negative values move it left. This is separate from abctitlepad, which controls spacing between abc and title when co-located. If float, units are points. If string, interpreted by units.
abc_kw, title_kw (dict-like, optional) – Additional settings used to update the a-b-c label and title with text.update().
titlepad (float, default: rc['title.pad'] = 5.0) – The padding for the inner and outer titles and a-b-c labels. If float, units are points. If string, interpreted by units.
titleabove (bool, default: rc['title.above'] = True) – Whether to try to put outer titles and a-b-c labels above panels, colorbars, or legends that are above the axes.
abctitlepad (float, default: rc['abc.titlepad'] = 4.0) – The horizontal padding between a-b-c labels and titles in the same location. If float, units are points. If string, interpreted by units.
ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle (str or sequence, :py:class:`optional `) – Shorthands for the below keywords. lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle : str or sequence, optional
lowerlefttitle, lowercentertitle, lowerrighttitle (str or sequence, optional) – Additional titles in specific positions (see title for details). 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 (**default* *) – rc['axes.alpha'] = None (default: 1.0), rc['axes.facecolor'] = 'white' (default: white), rc['axes.edgecolor'] = 'black' (default: black), rc['axes.linewidth'] = 0.6 (default: 0.6), - Additional settings applied to the background patch, and their shorthands. Their defaults values are the 'axes' properties.
**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 or unit-spec, default )
rc['leftlabel.pad'] = 5.0, rc['toplabel.pad'] = 5.0, rc['rightlabel.pad'] = 5.0, rc['bottomlabel.pad'] = 5.0 – The padding between the labels and the axes content. If float, units are points. If string, interpreted by units.
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 leftmost subplot and the right edge of the rightmost subplot.
suptitlepad (float, default: rc['suptitle.pad'] = 5.0) – The padding between the super title and the axes content. If float, units are points. If string, interpreted by units.
suptitle_kw (optional) – Additional settings used to update the super title with text.update().
includepanels (bool, default: False) – 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.
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, default: rc.margin = 0.05) – The default margin between plotted content and the x and y axis spines in axes-relative coordinates. This is useful if you don’t witch to explicitly set axis limits. Use the keyword 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 ({'b', 't', 'l', 'r', '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 ({'b', 't', 'l', 'r', '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 ({'b', 't', 'l', 'r', '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 ({'b', 't', 'l', 'r', '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 ({'b', 't', 'l', 'r', 'bottom', 'top', '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'}, optional) – Direction that major and minor tick marks point for the x and y axis. Use the keyword tickdir to control both.
xticklabeldir, yticklabeldir ({'in', 'out'}, optional) – 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, default: 0) – The rotation for x and y axis tick labels. for normal axes, rc['formatter.timerotation'] = 'vertical' for time x axes.
xgrid, ygrid, grid (bool, default: rc.grid = True) – Whether to draw major gridlines on the x and y axis. Use the keyword grid to toggle both.
xgridminor, ygridminor, gridminor (bool, default: rc.gridminor = False) – Whether to draw minor gridlines for the x and y axis. Use the keyword gridminor to toggle both.
xtickminor, ytickminor, tickminor (bool, default: rc['tick.minor'] = True) – Whether to draw minor ticks on the x and y axes. Use the keyword 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, default: rc['meta.color'] = 'black') – Color for the x and y axis spines, ticks, tick labels, and axis labels. Use the keyword color to set both at once.
xgridcolor, ygridcolor, gridcolor (color-spec, default: rc['grid.color'] = 'black') – Color for the x and y axis major and minor gridlines. Use the keyword gridcolor to set both at once.
xlinewidth, ylinewidth, linewidth (color-spec, default: rc['meta.width'] = 0.6) – Line width for the x and y axis spines and major ticks. Propagates to tickwidth unless specified otherwise. Use the keyword linewidth to set both at once.
xtickcolor, ytickcolor, tickcolor (color-spec, default: rc['tick.color'] = 'black') – Color for the x and y axis ticks. Defaults are xcolor, ycolor, and color if they were passed. Use the keyword tickcolor to set both at once.
xticklen, yticklen, ticklen (unit-spec, default: rc['tick.len'] = 4.0) – Major tick lengths for the x and y axis. If float, units are points. If string, interpreted by units. Use the keyword ticklen to set both at once.
xticklenratio, yticklenratio, ticklenratio (float, default: rc['tick.lenratio'] = 0.5) – Relative scaling of xticklen and yticklen used to determine minor tick lengths. Use the keyword ticklenratio to set both at once.
xtickwidth, ytickwidth, tickwidth, (unit-spec, default: rc['tick.width'] = 0.6) – Major tick widths for the x ans y axis. Default is linewidth if it was passed. If float, units are points. If string, interpreted by units. Use the keyword tickwidth to set both at once.
xtickwidthratio, ytickwidthratio, tickwidthratio (float, default: rc['tick.widthratio'] = 0.8) – Relative scaling of xtickwidth and ytickwidth used to determine minor tick widths. Use the keyword tickwidthratio to set both at once.
xticklabelpad, yticklabelpad, ticklabelpad (unit-spec, default: rc['tick.labelpad'] = 2.0) – The padding between the x and y axis ticks and tick labels. Use the keyword ticklabelpad to set both at once. If float, units are points. If string, interpreted by units.
xticklabelcolor, yticklabelcolor, ticklabelcolor (color-spec, default: rc['tick.labelcolor'] = 'black') – Color for the x and y tick labels. Defaults are xcolor, ycolor, and color if they were passed. Use the keyword ticklabelcolor to set both at once.
xticklabelsize, yticklabelsize, ticklabelsize (unit-spec or str, default: rc['tick.labelsize'] = 'medium') – Font size for the x and y tick labels. If float, units are points. If string, interpreted by units. Use the keyword ticklabelsize to set both at once.
xticklabelweight, yticklabelweight, ticklabelweight (str, default: rc['tick.labelweight'] = 'normal') – Font weight for the x and y tick labels. Use the keyword ticklabelweight to set both at once.
xlabelpad, ylabelpad (unit-spec, default: rc['label.pad'] = 4.0) – The padding between the x and y axis bounding box and the x and y axis labels. If float, units are points. If string, interpreted by units.
xlabelcolor, ylabelcolor, labelcolor (color-spec, default: rc['label.color'] = 'black') – Color for the x and y axis labels. Defaults are xcolor, ycolor, and color if they were passed. Use the keyword labelcolor to set both at once.
xlabelsize, ylabelsize, labelsize (unit-spec or str, default: rc['label.size'] = 'medium') – Font size for the x and y axis labels. If float, units are points. If string, interpreted by units. Use the keyword labelsize to set both at once.
xlabelweight, ylabelweight, labelweight (str, default: rc['label.weight'] = 'normal') – Font weight for the x and y axis labels. Use the keyword labelweight to set both at once.
fixticks (bool, default: False) – Whether to transform the tick locators to a FixedLocator. If your axis ticks are doing weird things (for example, ticks are drawn outside of the axis spine) you can try setting this to True.
r0 (float, default: 0) – The radial origin.
theta0 ({'N', 'NW', 'W', 'SW', 'S', 'SE', 'E', 'NE'}, optional) – The zero azimuth location.
thetadir ({1, -1, 'anticlockwise', 'counterclockwise', 'clockwise'}, optional) – The positive azimuth direction. Clockwise corresponds to -1 and anticlockwise corresponds to 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 the keyword grid to toggle both.
thetagridminor, rgridminor, gridminor (bool, optional) – Whether to draw minor gridlines for the azimuthal and radial axis. Use the keyword gridminor to toggle both.
thetagridcolor, rgridcolor, gridcolor (color-spec, optional) – Color for the major and minor azimuthal and radial gridlines. Use the keyword 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, default: rc['meta.color'] = 'black') – Color for the axes edge. Propagates to labelcolor unless specified otherwise (similar to format()).
labelcolor, gridlabelcolor (color-spec, default: color or rc['grid.labelcolor'] = 'black') – Color for the gridline labels.
labelpad, gridlabelpad (unit-spec, default: rc['grid.labelpad'] = 3.0) – The padding between the axes edge and the radial and azimuthal labels. If float, units are points. If string, interpreted by units.
labelsize, gridlabelsize (unit-spec or str, default: rc['grid.labelsize'] = 'medium') – Font size for the gridline labels. If float, units are points. If string, interpreted by units.
labelweight, gridlabelweight (str, default: rc['grid.labelweight'] = 'normal') – Font weight for the gridline labels.
round (bool, default: rc['geo.round'] = True) – For polar cartopy axes only. Whether to bound polar projections with circles rather than squares. Note that outer gridline labels cannot be added to circle-bounded polar projections. When basemap is the backend this argument must be passed to Proj instead.
extent ({'globe', 'auto'}, default: rc['geo.extent'] = 'globe') – For cartopy axes only. Whether to auto adjust the map bounds based on plotted content. If 'globe' then non-polar projections are fixed with set_global, non-Gnomonic polar projections are bounded at the equator, and Gnomonic polar projections are bounded at 30 degrees latitude. If 'auto' nothing is done.
lonlim, latlim (2-tuple of float, optional) – For cartopy axes only. The approximate longitude and latitude boundaries of the map, applied with set_extent. When basemap is the backend this argument must be passed to Proj instead.
boundinglat (float, optional) – For cartopy axes only. The edge latitude for the circle bounding North Pole and South Pole-centered projections. When basemap is the backend this argument must be passed to Proj instead.
longrid, latgrid, grid (bool, default: rc.grid = True) – Whether to draw longitude and latitude gridlines. Use the keyword grid to toggle both at once.
longridminor, latgridminor, gridminor (bool, default: rc.gridminor = False) – Whether to draw “minor” longitude and latitude lines. Use the keyword gridminor to toggle both at once.
lonticklen, latticklen, ticklen (unit-spec, default: rc['tick.len'] = 4.0) – Major tick lengths for the longitudinal (x) and latitude (y) axis. If float, units are points. If string, interpreted by units. Use the keyword ticklen to set both at once.
latmax (float, default: 80) – The maximum absolute latitude for gridlines. Longitude gridlines are cut off poleward of this value (note this feature does not work in cartopy 0.18).
nsteps (int, default: rc['grid.nsteps'] = 250) – For cartopy axes only. The number of interpolation steps used to draw gridlines.
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.
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.
lonlabels, latlabels, labels (str, bool, or sequence, rc['grid.labels'] = False) – Whether to add non-inline longitude and latitude gridline labels, and on which sides of the map. Use the keyword labels to set both at once. The argument must conform to one of the following options:
- A boolean. True indicates the bottom side for longitudes and the left side for latitudes, and False disables all labels.
- A string or sequence of strings indicating the side names, e.g. 'top' for longitudes or ('left', 'right') for latitudes.
- A string indicating the side names with single characters, e.g. 'bt' for longitudes or 'lr' for latitudes.
- A string matching 'neither' (no labels), 'both' (equivalent to 'bt' for longitudes and 'lr' for latitudes), or 'all' (equivalent to 'lrbt', i.e. all sides).
- A boolean 2-tuple indicating whether to draw labels on the (bottom, top) sides for longitudes, and the (left, right) sides for latitudes.
- 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.
loninline, latinline, inlinelabels (bool, default: rc['grid.inlinelabels'] = False) – For cartopy axes only. Whether to add inline longitude and latitude gridline labels. Use the keyword inlinelabels to set both at once.
rotatelabels (bool, default: rc['grid.rotatelabels'] = False) – For cartopy axes only. Whether to rotate non-inline gridline labels so that they automatically follow the map boundary curvature.
labelrotation (float, optional) – The rotation angle in degrees for both longitude and latitude tick labels. Use lonlabelrotation and latlabelrotation to set them separately.
lonlabelrotation (float, optional) – The rotation angle in degrees for longitude tick labels. Works for both cartopy and basemap backends.
latlabelrotation (float, optional) – The rotation angle in degrees for latitude tick labels. Works for both cartopy and basemap backends.
labelpad (unit-spec, default: rc['grid.labelpad'] = 3.0) – For cartopy axes only. The padding between non-inline gridline labels and the map boundary. If float, units are points. If string, interpreted by units.
dms (bool, default: rc['grid.dmslabels'] = True) – For cartopy axes only. 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 ax.format(lonlocator='deglon', latlocator='deglat') and ax.format(lonformatter='deglon', latformatter='deglat').
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. Use dms=False to disable this.
lonformatter_kw, latformatter_kw (dict-like, optional) – Keyword arguments passed to the matplotlib.ticker.Formatter class.
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. When basemap is the backend this must be passed to Proj instead.
color (color-spec, default: rc['meta.color'] = 'black') – The color for the axes edge. Propagates to labelcolor unless specified otherwise (similar to format()).
gridcolor (color-spec, default: rc['grid.color'] = 'black') – The color for the gridline labels.
labelcolor (color-spec, default: color or rc['grid.labelcolor'] = 'black') – The color for the gridline labels (gridlabelcolor is also allowed).
labelsize (unit-spec or str, default: rc['grid.labelsize'] = 'medium') – The font size for the gridline labels (gridlabelsize is also allowed). If float, units are points. If string, interpreted by units.
labelweight (str, default: rc['grid.labelweight'] = 'normal') – The font weight for the gridline labels (gridlabelweight is also allowed).
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 ultraplot.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.