PlotAxes.parametric¶
- PlotAxes.parametric(x, y, c, *, interp=0, scalex=True, scaley=True, **kwargs)[source]¶
Plot a parametric line.
- Parameters
*args (
y
orx
,y
) – The data passed as positional or keyword arguments. Interpreted as follows:If only
y
coordinates are passed, try to infer thex
coordinates from theSeries
orDataFrame
indices or theDataArray
coordinates. Otherwise, thex
coordinates arenp.arange(0, y.shape[0])
.If the
y
coordinates are a 2D array, plot each column of data in succession (except where each column of data represents a statistical distribution, as withboxplot
,violinplot
, or when usingmeans=True
ormedians=True
).If any arguments are
pint.Quantity
, auto-add the pint unit registry to matplotlib’s unit registry usingsetup_matplotlib
. Apint.Quantity
embedded in anxarray.DataArray
is also supported.
c, color, colors, values (array-like, optional) – The parametric coordinate. These can be passed as a third positional argument or as a keyword argument. They can also be string labels instead of numbers and the resulting colorbar ticks will be labeled accordingly.
data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataArray
). If passed, positional arguments can optionally be stringdata
keys and the arrays used for plotting are retrieved withdata[key]
. This is a native matplotlib feature.autoformat (
bool
, optional) – Whether thex
axis labels,y
axis labels, axis formatters, axes titles, legend titles, and colorbar labels are automatically configured when aSeries
,DataFrame
,DataArray
, orQuantity
is passed to the plotting command. Default isrc.autoformat
=True
.
- Other Parameters
cmap (
colormap spec
, optional) – The colormap specifer, passed to theColormap
constructor function.norm (
normalizer spec
, optional) – The continuous colormap normalizer, passed to theNorm
constructor function. Ifdiscrete
isTrue
this is also used to normalize values passed toDiscreteNorm
before colors is selected.discrete (
bool
, optional) – IfFalse
, thenDiscreteNorm
is not applied to the colormap. Instead, for non-contour plots, the number of levels will be roughly controlled byrc['cmap.lut']
. This has a similar effect to usinglevels=large_number
but it may improve rendering speed. Default isFalse
forimshow
,matshow
,spy
,hexbin
,hist2d
, andheatmap
plots, butTrue
otherwise.sequential (
bool
, optional) – Userc['cmap.sequential']
='fire'
as the default colormap.diverging (
bool
, optional) – Userc['cmap.diverging']
='negpos'
as the default colormap and useDivergingNorm
as the default continuous normalizer. This will also ensure auto-generated levels include a value at zero.cyclic (
bool
, optional) – Userc['cmap.cyclic']
='twilight'
as the default colormap and modify the default arguments passed toDiscreteNorm
so that colors on either end are distinct.sequential, diverging, cyclic, qualitative (
bool
, optional) – Boolean arguments used ifcmap
is not passed. Set these toTrue
to use the defaultrc['cmap.sequential']
,rc['cmap.diverging']
,rc['cmap.cyclic']
, andrc['cmap.qualitative']
colormaps. The latter three options also change level- and norm-generation behavior.extend (
{{'neither', 'min', 'max', 'both'}}
, optional) – Whether to assign unique colors to out-of-bounds data and draw colorbar “extensions” when a colorbar is drawn.vmin, vmax (
float
, optional) – Used to determine level locations iflevels
orvalues
is an integer. Actual levels may not fall exactly onvmin
andvmax
, but the minimum level will be no smaller thanvmin
and the maximum level will be no larger thanvmax
. Ifvmin
orvmax
are not provided, the minimum and maximum data values are used.colorbar (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or panel colorbar from the resulting object(s). IfTrue
, the defaultrc['colorbar.loc']
='right'
is used. Valid locations are described incolorbar
.colorbar_kw (dict-like, optional) – Extra keyword args for the call to
colorbar
.legend (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or panel legend from the resulting object(s). IfTrue
, the defaultrc['legend.loc']
='best'
is used. Valid locations are described inlegend
.legend_kw (dict-like, optional) – Extra keyword args for the call to
legend
.interp (
int
, optional) – Interpolate to this many additional points between the parametric coordinates. Default is0
. This can be increased to make the color gradations between a small number of coordinates appear “smooth”.scalex, scaley (
bool
, optional) – Whether the view limits are adapted to the data limits. The values are passed on toautoscale_view
.inbounds (
bool
, optional) – Whether to restrict the defaulty
(x
) axis limits to account for only in-bounds data when thex
(y
) axis limits have been locked. Default isrc['axes.inbounds']
=True
. See alsorc['cmap.inbounds']
.**kwargs – Valid
LineCollection
properties.
- Returns
LineCollection
– The parametric line. See this matplotlib example.