PolarAxes

class PolarAxes(*args, **kwargs)[source]

Bases: _SharedAxes, PlotAxes, PolarAxes

Axes subclass for plotting in polar coordinates. Adds the format method and overrides several existing methods.

Important

This axes subclass can be used by passing proj='polar' to axes-creation commands like add_axes, add_subplot, and subplots.

Parameters:

*args – Passed to matplotlib.axes.Axes.
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.

Other 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.
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 – Remaining keyword arguments are passed to matplotlib.axes.Axes.n 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.

Attributes Summary

name

Methods Summary

`format`()	Modify axes limits, radial and azimuthal gridlines, and more.
`set`(*[, adjustable, agg_filter, alpha, ...])	Set multiple properties at once.

Attributes Documentation

name = 'polar'

Methods Documentation

format()[source]

Modify axes limits, radial and azimuthal gridlines, and more. Note that all of the theta arguments are specified in degrees, not radians.

Parameters:

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.

Other 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.
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.
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.

Property	Description
`adjustable`	{‘box’, ‘datalim’}
`agg_filter`	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
`alpha`	float or None
`anchor`	(float, float) or {‘C’, ‘SW’, ‘S’, ‘SE’, ‘E’, ‘NE’, …}
`animated`	bool
`aspect`	{‘auto’, ‘equal’} or float
`autoscale_on`	bool
`autoscalex_on`	unknown
`autoscaley_on`	unknown
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool or ‘line’
`box_aspect`	float or None
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`external`	unknown
`facecolor` or `fc`	:mpltype:`color`
`figure`	`Figure` or `SubFigure`
`forward_navigation_events`	bool or “auto”
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	object
`mouseover`	bool
`navigate`	bool
`navigate_mode`	unknown
`path_effects`	list of `AbstractPathEffect`
`picker`	None or bool or float or callable
`position`	[left, bottom, width, height] or `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	float or None
`rasterized`	bool
`rgrids`	tuple with floats
`rlabel_position`	number
`rlim`	unknown
`rmax`	float
`rmin`	float
`rorigin`	float
`rscale`	unknown
`rticks`	unknown
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`subplotspec`	unknown
`theta_direction`	unknown
`theta_offset`	unknown
`theta_zero_location`	str
`thetagrids`	tuple with floats, degrees
`thetalim`	unknown
`thetamax`	unknown
`thetamin`	unknown
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	(lower: float, upper: float)
`xlabel`	str
`xlim`	(left: float, right: float)
`xmargin`	float greater than -0.5
`xscale`	unknown
`xticklabels`	unknown
`xticks`	unknown
`ybound`	(lower: float, upper: float)
`ylabel`	str
`ylim`	(bottom: float, top: float)
`ymargin`	float greater than -0.5
`yscale`	unknown
`yticklabels`	unknown
`yticks`	unknown
`zorder`	float