CartesianAxes

class CartesianAxes(*args, **kwargs)

Bases: _SharedAxes, PlotAxes

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

Important

This is the default axes subclass. It can be specified explicitly by passing proj='cart', proj='cartesian', proj='rect', or proj='rectilinear' to axes-creation commands like add_axes, add_subplot, and subplots.

Parameters

• *args – Passed to matplotlib.axes.Axes.

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

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 simply be selected from the sequence according to number.

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

• 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, optional) – Shorthands for the below keywords.

• lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle, 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, 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.

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

See also

CartesianAxes.format, proplot.axes.Axes, proplot.axes.PlotAxes, proplot.figure.Figure.subplot, proplot.figure.Figure.add_subplot

Methods Summary

altx(**kwargs)	Add an axes locked to the same location with a distinct x axis.
alty(**kwargs)	Add an axes locked to the same location with a distinct y axis.
dualx(funcscale, **kwargs)	Add an axes locked to the same location whose x axis denotes equivalent coordinates in alternate units.
dualy(funcscale, **kwargs)	Add an axes locked to the same location whose y axis denotes equivalent coordinates in alternate units.
format()	Modify axes limits, axis scales, axis labels, spine locations, tick locations, tick labels, and more.
twinx(**kwargs)	Add an axes locked to the same location with a distinct y axis.
twiny(**kwargs)	Add an axes locked to the same location with a distinct x axis.