PolarAxes.format¶
- PolarAxes.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 to1
.thetamin, thetamax (
float
, optional) – The lower and upper azimuthal bounds in degrees. Ifthetamax != thetamin + 360
, this produces a sector plot.thetalim (
2-tuple
offloat
orNone
, optional) – Specifiesthetamin
andthetamax
at once.rmin, rmax (
float
, optional) – The inner and outer radial limits. Ifr0 != rmin
, this produces an annular plot.rlim (
2-tuple
offloat
orNone
, optional) – Specifiesrmin
andrmax
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 keywordgrid
to toggle both.thetagridminor, rgridminor, gridminor (
bool
, optional) – Whether to draw minor gridlines for the azimuthal and radial axis. Use the keywordgridminor
to toggle both.thetagridcolor, rgridcolor, gridcolor (
color-spec
, optional) – Color for the major and minor azimuthal and radial gridlines. Use the keywordgridcolor
to set both at once.thetalocator, rlocator (
locator-spec
, optional) – Used to determine the azimuthal and radial gridline positions. Passed to theLocator
constructor. Can be float, list of float, string, ormatplotlib.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 theFormatter
constructor. Can be string, list of string, ormatplotlib.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 tolabelcolor
unless specified otherwise (similar toproplot.axes.CartesianAxes.format
).labelcolor, gridlabelcolor (
color-spec
, default:color
orrc['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 byunits
.labelsize, gridlabelsize (
unit-spec
orstr
, default:rc['grid.labelsize']
='medium'
) – Font size for the gridline labels. If float, units are points. If string, interpreted byunits
.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 tonumber
.abc (
bool
orstr
or sequence, default:rc.abc
=False
) – The “a-b-c” subplot label style. Must contain the charactera
orA
, for example'a.'
, or'A'
. IfTrue
then the default style of'a'
is used. Thea
orA
is replaced with the alphabetic character matching thenumber
. Ifnumber
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 simply be selected from the sequence according tonumber
.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'
abcborder, titleborder (
bool
, default:rc['abc.border']
=True
andrc['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
andrc['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.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 byunits
.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 byunits
.ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle (
str
or sequence, optional) – Shorthands for the below keywords.lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle, lowerlefttitle, lowercentertitle, lowerrighttitle (
str
or sequence, optional) – Additional titles in specific positions (seetitle
for details). This works as an alternative to theax.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
,rc['axes.facecolor']
='white'
,rc['axes.edgecolor']
='black'
,rc['axes.linewidth']
=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
andtoplabels
, and forleftlabels
,toplabels
,rightlabels
, andbottomlabels
, 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
orunit-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 byunits
.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 byunits
.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 thespanx
x axis labels andspany
y axis labels along the sides of the subplot grid.rc_mode (
int
, optional) – The context mode passed tocontext
.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 toproplot.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 therc.abc
setting,titleloc='left'
modifies therc['title.loc']
setting,gridminor=True
modifies therc.gridminor
setting, andgridbelow=True
modifies therc['grid.below']
setting. Many of the keyword arguments documented above are internally applied by retrieving settings passed tocontext
.