scatter_extras¶

scatter_extras(self, *args, **kwargs)[source]¶

Support apply_cmap features and support keywords that are more consistent with plot keywords.

Important

This function wraps scatter.

Parameters

*args (y or x, y) – The input x or x and y coordinates. If only y is provided, x will be inferred from y.
s, size, markersize (float or list of float, optional) – The marker size(s). The units are optionally scaled by smin and smax.
smin, smax (float, optional) – The minimum and maximum marker size in units points^2 used to scale s. If not provided, the marker sizes are equivalent to the values in s.
c, color, markercolor (color-spec or list thereof, or array, optional) – The marker fill color(s). If this is an array of scalar values, colors will be generated using the colormap cmap and normalizer norm.
vmin, vmax (float, optional) – Used to determine level locations if levels or values is an integer. Actual levels may not fall exactly on vmin and vmax, but the minimum level will be no smaller than vmin and the maximum level will be no larger than vmax. If vmin or vmax are not provided, the minimum and maximum data values are used.

cmapcolormap spec, optional: The colormap specifer, passed to the Colormap constructor.
cmap_kwdict-like, optional: Passed to Colormap.
normnormalizer spec, optional: The colormap normalizer, used to warp data before passing it to DiscreteNorm. This is passed to the Norm constructor.
norm_kwdict-like, optional: Passed to Norm.
extend{{‘neither’, ‘min’, ‘max’, ‘both’}}, optional: Whether to assign unique colors to out-of-bounds data and draw “extensions” (triangles, by default) on the colorbar.
N: Shorthand for levels.
levelsint or list of float, 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 with pcolor plots, not contour plots). Default is rc[‘image.levels’] = 11.
valuesint or list of float, 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 using edges. This will override any levels input.
discretebool, optional: If False, the DiscreteNorm is not applied to the colormap when levels=N or levels=array_of_values are not explicitly requested. Instead, the number of levels in the colormap will be roughly controlled by rc[‘image.lut’]. This has a similar effect to using levels=large_number but it may improve rendering speed. By default, this is False only for imshow, matshow, spy, hexbin, and hist2d plots.
inboundsbool, optional: If True (the edefault), when automatically selecting levels in the presence of hard x and y axis limits (i.e., when set_xlim or set_ylim have been called previously), only the in-bounds data is sampled. Default is rc[‘image.inbounds’] = True.
locatorlocator-spec, optional: The locator used to determine level locations if levels or values is an integer and vmin and vmax were not provided. Passed to the Locator constructor. Default is MaxNLocator with levels integer levels.
locator_kwdict-like, optional: Passed to Locator.
symmetricbool, optional: If True, automatically generated levels are symmetric about zero.
positivebool, optional: If True, automatically generated levels are positive with a minimum at zero.
negativebool, optional: If True, automatically generated levels are negative with a maximum at zero.
nozerobool, optional: If True, 0 is removed from the level list. This is mainly useful for contour plots.
lw, linewidth, linewidths, markeredgewidth, markeredgewidthsfloat or list thereof, optional: The marker edge width.
edgecolors, markeredgecolor, markeredgecolorscolor-spec or list thereof, optional: The marker edge color.

Other Parameters: **kwargs – Passed to scatter.