CartesianAxes.format¶
- CartesianAxes.format(**kwargs)[source]¶
Modify the x and y axis labels, tick locations, tick labels, axis scales, spine settings, and more. Additional keyword arguments are passed to
Axes.format
andcontext
.- Parameters
aspect (
{'auto', 'equal'}
, optional) – The aspect ratio mode. Seeset_aspect
for details.xlabel, ylabel (
str
, optional) – The x and y axis labels. Applied withset_xlabel
andset_ylabel
.xlabelpad, ylabelpad (
float
orstr
, optional) – The padding between the x and y axis bounding box and the x and y axis labels. Default isrc['label.pad']
=4.0
. If float, units are points. If string, interpreted byunits
.xlabel_kw, ylabel_kw (dict-like, optional) – Additional settings used to update the axis labels with
text.update()
.xlim, ylim (
2-tuple
offloats
orNone
, optional) – The x and y axis data limits. Applied withset_xlim
andset_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 (
axis scale spec
, optional) – The x and y axis scales. Passed to theScale
constructor. For example,xscale='log'
applies logarithmic scaling, andxscale=('cutoff', 100, 2)
applies aCutoffScale
.xscale_kw, yscale_kw (dict-like, optional) – The x and y axis scale settings. Passed to
Scale
.xspineloc, yspineloc (
{'both', 'bottom', 'top', 'left', 'right', 'neither', 'center', 'zero'}
, optional) – The x and y axis spine locations.xloc, yloc (optional) – Aliases for
xspineloc
,yspineloc
.xtickloc, ytickloc (
{'both', 'bottom', 'top', 'left', 'right', 'neither'}
, optional) – Which x and y axis spines should have major and minor tick marks.xtickminor, ytickminor, tickminor (
bool
, optional) – Whether to draw minor ticks on the x and y axes.xtickdir, ytickdir, tickdir (
{'out', 'in', 'inout'}
) – Direction that major and minor tick marks point for the x and y axis. Usetickdir
to control both.xticklabeldir, yticklabeldir (
{'in', 'out'}
) – Whether to place x and y axis tick label text inside or outside the axes.xticklabelpad, yticklabelpad (
float
orstr
, optional) – The padding between the x and y axis ticks and tick labels. Default isrc['tick.labelpad']
. If float, units are points. If string, interpreted byunits
.xgrid, ygrid, grid (
bool
, optional) – Whether to draw major gridlines on the x and y axis. Usegrid
to toggle both.xgridminor, ygridminor, gridminor (
bool
, optional) – Whether to draw minor gridlines for the x and y axis. Usegridminor
to toggle both.xlocator, ylocator (
locator spec
, optional) – Used to determine the x and y axis tick mark positions. Passed to theLocator
constructor. Can be float, list of float, string, ormatplotlib.ticker.Locator
instance. Use[]
,'null'
, or'none'
for no ticks.xticks, yticks (optional) – Aliases for
xlocator
,ylocator
.xlocator_kw, ylocator_kw (dict-like, optional) – Keyword arguments passed to the
matplotlib.ticker.Locator
class.xminorlocator, yminorlocator (optional) – As for
xlocator
,ylocator
, but for the minor ticks.xminorticks, yminorticks (optional) – Aliases for
xminorlocator
,yminorlocator
.xminorlocator_kw, yminorlocator_kw – As for
xlocator_kw
,ylocator_kw
, but for the minor locator.xformatter, yformatter (
formatter spec
, optional) – Used to determine the x and y axis tick label string format. Passed to theFormatter
constructor. Can be string, list of strings, ormatplotlib.ticker.Formatter
instance. Use[]
,'null'
, or'none'
for no labels.xticklabels, yticklabels (optional) – Aliases for
xformatter
,yformatter
.xformatter_kw, yformatter_kw (dict-like, optional) – Keyword arguments passed to the
matplotlib.ticker.Formatter
class.xrotation, yrotation (
float
, optional) – The rotation for x and y axis tick labels. Default is0
for normal axes,rc['formatter.timerotation']
='vertical'
for time x axes.xbounds, ybounds (
(float
,float)
, optional) – The x and y axis data bounds within which to draw the spines. For example, the axis range(0, 4)
with bounds(1, 4)
will prevent the spines from meeting at the origin.xtickrange, ytickrange (
(float
,float)
, optional) – The x and y axis data ranges within which major tick marks are labelled. For example, the tick range(-1, 1)
with axis range(-5, 5)
and a tick interval of 1 will only label the ticks marks at -1, 0, and 1. SeeAutoFormatter
for details.xwraprange, ywraprange (
(float
,float)
, optional) – The x and y axis data ranges with which major tick mark values are wrapped. For example, the wrap range(0, 3)
causes the values 0 through 9 to be formatted as 0, 1, 2, 0, 1, 2, 0, 1, 2, 0. SeeAutoFormatter
for details.xmargin, ymargin, margin (
float
, optional) – The default margin between plotted content and the x and y axis spines. Value is proportional to the width, height of the axes. Use this if you want whitespace between plotted content and the spines, but don’t want to explicitly setxlim
orylim
.xticklen, yticklen, ticklen (
float
orstr
, optional) – Tick lengths for the x and y axis. Units are interpreted byunits
, with “points” as the numeric unit. Default isrc.ticklen
. Minor tick lengths are scaled according torc['tick.lenratio']
=0.5
. Useticklen
andticklenratio
to set both at once.xlinewidth, ylinewidth, linewidth (
color-spec
, optional) – Line width for the x and y axis spines and major ticks. Uselinewidth
to set both at once.xcolor, ycolor, color (
color-spec
, optional) – Color for the x and y axis spines, ticks, tick labels, and axis labels. Usecolor
to set both at once.xgridcolor, ygridcolor, gridcolor (
color-spec
, optional) – Color for the x and y axis major and minor gridlines. Usegridcolor
to set both at once.fixticks (
bool
, optional) – Whether to always transform the tick locators to aFixedLocator
instance. Default isFalse
. If your axis ticks are doing weird things (for example, ticks drawn outside of the axis spine), try setting this toTrue
.
- Other Parameters
title (
str
, optional) – The axes title.abc (
bool
orstr
, optional) – 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.abcloc, titleloc (
str
, optional) – Strings indicating the location for the a-b-c label and main title. The following locations are valid (defaults arerc['abc.loc']
='left'
andrc['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 arerc['abc.border']
=True
andrc['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 arerc['abc.bbox']
=False
andrc['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 isrc['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 isrc['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 isrc['abc.titlepad']
=4.0
.ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle (
str
, optional) – Additional titles in specific positions. This works as an alternative to theax.format(title='Title', titleloc=loc)
workflow and permits adding more than one title-like label to 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.rowlabels, collabels, llabels, tlabels, rlabels, blabels – Aliases for
leftlabels
andtoplabels
, and forleftlabels
,toplabels
,rightlabels
, andbottomlabels
, respectively.leftlabels, toplabels, rightlabels, bottomlabels (
list
ofstr
, 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 arerc['leftlabel.pad']
,rc['toplabel.pad']
,rc['rightlabel.pad']
, andrc['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 isrc['suptitle.pad']
.suptitle_kw (optional) – Additional settings used to update the super title with
text.update()
.rc_mode (
int
, optional) – The context mode passed tocontext
.rc_kw (dict-like, optional) – An alternative to passing extra keyword arguments. See below.
**kwargs – Passed to
proplot.config.Configurator.context
and used to update the axes-relevantrc
settings. For example,abcstyle='A.'
modifies therc['abc.style']
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 actually applied by updating therc
settings then retrieving the updated settings.
Note
If you plot something with a datetime64,
pandas.Timestamp
,pandas.DatetimeIndex
,datetime.date
,datetime.time
, ordatetime.datetime
array as the x or y axis coordinate, the axis ticks and tick labels will be automatically formatted as dates.