PlotAxes.scatter¶
- PlotAxes.scatter(*args, **kwargs)[source]¶
Plot markers with flexible keyword arguments.
- 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.
s, size, ms, markersize (
float
orlist
offloat
, optional) – The marker size(s). If this is an array matching the shape ofx
andy
, the units are scaled bysmin
andsmax
.c, color, colors, mc, markercolor, markercolors (
color-spec
orlist thereof
, orarray
, optional) – The marker fill color(s). If this is an array matching the shape ofx
andy
, the colors are generated usingcmap
,norm
,vmin
, andvmax
.smin, smax (
float
, optional) – The minimum and maximum marker size in unitspoints**2
used to scales
. If not provided, the marker sizes are equivalent to the values ins
.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.data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataArray
). If passed, positional arguments can optionally be validdata
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
lw, linewidth, linewidths, markeredgewidth, markeredgewidths (
float
orlist thereof
, optional) – The marker edge width.edgecolors, markeredgecolor, markeredgecolors (
color-spec
orlist thereof
, optional) – The marker edge color.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.N – Shorthand for
levels
.levels (
int
orlist
offloat
, optional) – The number of level edges or a list of level edges. If the former,locator
is used to generate this many level edges at “nice” intervals. If the latter, the levels should be monotonically increasing or decreasing (note that decreasing levels will only work withpcolor
plots, notcontour
plots). Default isrc['cmap.levels']
=11
.values (
int
orlist
offloat
, optional) – The number of level centers or a list of level centers. If the former,locator
is used to generate this many level centers at “nice” intervals. If the latter, levels are inferred usingedges
. This will override anylevels
input.robust (
bool
,float
, or2-tuple
, optional) – IfTrue
andvmin
orvmax
were not provided, they are determined from the 2nd and 98th data percentiles rather than the minimum and maximum. If float, this percentile range is used (for example,90
corresponds to the 5th to 95th percentiles). If 2-tuple of float, these specific percentiles should be used. This feature is useful when your data has large outliers. Default isrc['cmap.robust']
=False
.inbounds (
bool
, optional) – IfTrue
andvmin
orvmax
were not provided, when axis limits have been explicitly restricted withset_xlim
orset_ylim
, out-of-bounds data is ignored. Default isrc['cmap.inbounds']
=True
. See alsorc['axes.inbounds']
.locator (
locator-spec
, optional) – The locator used to determine level locations iflevels
orvalues
is an integer. Passed to theLocator
constructor. Default isMaxNLocator
withlevels
integer levels.symmetric (
bool
, optional) – IfTrue
, automatically generated levels are symmetric about zero. Default is alwaysFalse
.positive (
bool
, optional) – IfTrue
, automatically generated levels are positive with a minimum at zero. Default is alwaysFalse
.negative (
bool
, optional) – IfTrue
, automatically generated levels are negative with a maximum at zero. Default is alwaysFalse
.nozero (
bool
, optional) – IfTrue
,0
is removed from the level list. This is mainly useful for single-colorcontour
plots.cycle (
cycle-spec
, optional) – The cycle specifer, passed to theCycle
constructor. If the returned cycler is unchanged from the current cycler, the axes cycler will not be reset to its first position. To disable property cycling and just use black for the default color, usecycle=False
,cycle='none'
, orcycle=()
(analogous to disabling ticks with e.g.xformatter='none'
). To restore the default property cycler, usecycle=True
.label, value (
float
orstr
, optional) – The single legend label or colorbar coordinate to be used for this plotted element. This is generally used with 1D input coordinates.labels, values (
list
offloat
orlist
ofstr
, optional) – The legend labels or colorbar coordinates used for each plotted element. Can be numeric or string, and must match the number of plotted elements. This is generally used with 2D input coordinates.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 default location is used. Valid locations are described incolorbar
.colorbar_kw (dict-like, optional) – Ignored if
colorbar
isNone
. Extra keyword args for the call tocolorbar
.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 default location is used. Valid locations are described inlegend
.legend_kw (dict-like, optional) – Ignored if
legend
isNone
. Extra keyword args for the call tolegend
.mean, means (
bool
, optional) – Whether to plot the means of each column for 2Dy
coordinates. Means are calculated withnumpy.nanmean
. If no other arguments are specified, this also setsbarstd=True
(andboxstd=True
for violin plots).median, medians (
bool
, optional) – Whether to plot the medians of each column for 2Dy
coordinates. Medians are calculated withnumpy.nanmedian
. If no other arguments arguments are specified, this also setsbarstd=True
(andboxstd=True
for violin plots).barstd, barstds (
float
,(float
,float)
, orbool
, optional) – Valid only if `mean` or `median` is ``True``. Standard deviation multiples for thin error bars with optional whiskers (i.e., caps). If scalar, then +/- that multiple is used. IfTrue
, the default standard deviation range of +/-3 is used.barpctile, barpctiles (
float
,(float
,float)
orbool
, optional) – Valid only if `mean` or `median` is ``True``. As withbarstd
, but instead using percentiles for the error bars. If scalar, that percentile range is used (e.g.,90
shows the 5th to 95th percentiles). IfTrue
, the default percentile range of 0 to 100 is used.bardata (
2 x N array
or1D array
, optional) – Valid only if `mean` and `median` are ``False``. If shape is 2 x N, these are the lower and upper bounds for the thin error bars. If shape is N, these are the absolute, symmetric deviations from the central points.boxstd, boxstds, boxpctile, boxpctiles, boxdata (optional) – As with
barstd
,barpctile
, andbardata
, but for thicker error bars representing a smaller interval than the thin error bars. Ifboxstd
isTrue
, the default standard deviation range of +/-1 is used. Ifboxpctiles
isTrue
, the default percentile range of 25 to 75 is used (i.e., the interquartile range). When “boxes” and “bars” are combined, this has the effect of drawing miniature box-and-whisker plots.capsize (
float
, optional) – The cap size for thin error bars in points. Default isrc['errorbar.capsize']
=3.0
.barz, barzorder, boxz, boxzorder (
float
, optional) – The “zorder” for the thin and thick error bars. Default is2.5
.barc, barcolor, boxc, boxcolor (
color-spec
, optional) – Colors for the thin and thick error bars. Default isrc['boxplot.whiskerprops.color']
='black'
.barlw, barlinewidth, boxlw, boxlinewidth (
float
, optional) – Line widths for the thin and thick error bars, in points. The defaultsrc['boxplot.whiskerprops.linewidth']
=1.0
(bars) and four times that value (boxes).boxm, boxmarker (
bool
ormarker-spec
, optional) – Whether to draw a small marker in the middle of the box denoting the mean or median position. Ignored ifboxes
isFalse
. Default is'o'
.boxms, boxmarkersize (
size-spec
, optional) – The marker size for theboxmarker
marker in points ** 2. Default size is equal to(2 * boxlinewidth) ** 2
.boxmc, boxmarkercolor, boxmec, boxmarkeredgecolor (
color-spec
, optional) – Color, face color, and edge color for theboxmarker
marker. Default color and edge color are'w'
.shadestd, shadestds, shadepctile, shadepctiles, shadedata (optional) – As with
barstd
,barpctile
, andbardata
, but using shading to indicate the error range. Ifshadestds
isTrue
, the default standard deviation range of +/-2 is used. Ifshadepctiles
isTrue
, the default percentile range of 10 to 90 is used.fadestd, fadestds, fadepctile, fadepctiles, fadedata (optional) – As with
shadestd
,shadepctile
, andshadedata
, but for an additional, more faded, secondary shaded region. Iffadestds
isTrue
, the default standard deviation range of +/-3 is used. Iffadepctiles
isTrue
, the default percentile range of 0 to 100 is used.shadec, shadecolor, fadec, fadecolor (
color-spec
, optional) – Colors for the different shaded regions. Default is to inherit the parent color.shadez, shadezorder, fadez, fadezorder (
float
, optional) – The “zorder” for the different shaded regions. Default is1.5
.shadea, shadealpha, fadea, fadealpha (
float
, optional) – The opacity for the different shaded regions. Defaults are0.4
and0.2
.shadelw, shadelinewidth, fadelw, fadelinewidth (
float
, optional) – The edge line width for the shading patches. Default isrc['patch.linewidth']
=0.6
.shdeec, shadeedgecolor, fadeec, fadeedgecolor (
float
, optional) – The edge color for the shading patches. Default is'none'
.shadelabel, fadelabel (
bool
orstr
, optional) – Labels for the shaded regions to be used as separate legend entries. To toggle labels “on” and apply a default label, use e.g.shadelabel=True
. To apply a custom label, use e.g.shadelabel='label'
. Otherwise, the shading is drawn underneath the line and/or marker in the legend entry.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 – Passed to
scatter
.