Bases: matplotlib.collections.Collection
Represents a sequence of Line2Ds that should be drawn together.
This class extends Collection to represent a sequence of Line2Ds instead of just a sequence of Patchs. Just as in Collection, each property of a LineCollection may be either a single value or a list of values. This list is then used cyclically for each element of the LineCollection, so the property of the ith element of the collection is:
The properties of each member of a LineCollection default to their values in rcParams["lines.*"] instead of rcParams["patch.*"], and the property colors is added in place of edgecolors.
A sequence of (line0, line1, line2), where:
or the equivalent numpy array with two columns. Each line can have a different number of segments.
The width of each line in points.
A sequence of RGBA tuples (e.g., arbitrary color strings, etc, not allowed).
Whether to use antialiasing for each line.
zorder of the lines once drawn.
When setting facecolors, each line is interpreted as a boundary for an area, implicitly closing the path from the last point to the first point. The enclosed area is filled with facecolor. In order to manually specify what should count as the "interior" of each line, please use PathCollection instead, where the "interior" can be specified by appropriate usage of CLOSEPOLY.
Forwarded to Collection.
Add a callback function that will be called whenever one of the Artist's properties changes.
The callback function. It must have the signature:
where artist is the calling Artist. Return values may exist but are ignored.
The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.
See also
Autoscale the scalar limits on the norm instance using the current array
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
The Axes instance the artist resides in, or None.
Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.
The last colorbar associated with this ScalarMappable. May be None.
Test whether the mouse event occurred in the collection.
Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.
Convert x using the unit type of the xaxis.
If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.
Convert y using the unit type of the yaxis.
If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.
Find artist objects.
Recursively find all Artist instances contained in the artist.
A filter criterion for the matches. This can be
Include self in the list to be checked for a match.
Return a string representation of data.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.
See also
Return filter function to be used for agg filter.
Return the alpha value used for blending - not supported on all backends.
Return whether the artist is animated.
Return the array of values, that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array.
Return a list of the child Artists of this Artist.
Return the values (min, max) that are mapped to the colormap limits.
Return the clipbox.
Return whether the artist uses clipping.
Return the clip path.
Return the Colormap instance.
Return the cursor data for a given event.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.
Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation.
The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.
See also
Alias for get_linestyle.
Alias for get_edgecolor.
Alias for get_edgecolor.
Alias for get_facecolor.
Alias for get_facecolor.
Return the Figure instance the artist belongs to.
Return whether face is colored.
Return the group id.
Return the current hatching pattern.
Return boolean flag, True if artist is included in layout calculations.
E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
Return the label used for this artist in the legend.
Alias for get_linestyle.
Alias for get_linewidth.
Alias for get_linestyle.
Alias for get_linewidth.
Return the Transform instance used by this artist offset.
Return the offsets for the collection.
Return the picking behavior of the artist.
The possible values are described in set_picker.
See also
Return whether the artist is to be rasterized.
List of segments in the LineCollection. Each list item contains an array of vertices.
Return the sketch parameters for the artist.
A 3-tuple with the following elements:
Returns None if no sketch parameters were set.
Return the snap setting.
See set_snap for details.
Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).
Return the Transform instance used by this artist.
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
Return the url.
Return a list of URLs, one for each element of the collection.
The list contains None for elements without a URL. See Hyperlinks for an example.
Return the visibility.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Return the artist's zorder.
Return whether units are set on any axis.
Return whether the Artist has an explicitly set transform.
This is True after set_transform has been called.
If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it.
See also get_cursor_data(), ToolCursorPosition and NavigationToolbar2.
Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also
Process a pick event.
Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.
See also
Return whether the artist is pickable.
See also
Return a dictionary of all the properties of the artist.
Remove the artist from the figure if possible.
The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired.
Note: relim will not see collections even if the collection was added to the axes with autolim = True.
Note: there is no support for removing the artist's legend entry.
Remove a callback based on its observer id.
See also
Set multiple properties at once.
Supported properties are
Property
Description
agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha
array-like or scalar or None
animated
bool
antialiased or aa or antialiaseds
bool or list of bools
array
array-like or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clim
(vmin: float, vmax: float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
cmap
Colormap or str or None
color
color or list of colors
colors
color or list of colors
edgecolor or ec or edgecolors
color or list of colors or 'face'
facecolor or facecolors or fc
color or list of colors
figure
Figure
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle or dashes or linestyles or ls
str or tuple or list thereof
linewidth or linewidths or lw
float or list of floats
norm
Normalize or None
offset_transform
Transform
offsets
(N, 2) or (2,) array-like
path_effects
AbstractPathEffect
paths
unknown
picker
None or bool or float or callable
pickradius
float
rasterized
bool
segments
unknown
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
urls
list of str or None
verts
unknown
visible
bool
zorder
float
Alias for set_antialiased.
Set the agg filter.
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.
Set the alpha value used for blending - not supported on all backends.
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported.
Set whether the artist is intended to be used in an animation.
If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.
See also matplotlib.animation and Faster rendering by using blitting.
Set the antialiasing state for rendering.
Alias for set_antialiased.
Set the value array from array-like A.
The values that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A.
Set the CapStyle for the collection (for all its elements).
Set the norm limits for image scaling.
The limits.
The limits may also be passed as a tuple (vmin, vmax) as a single positional argument.
Set the artist's clip Bbox.
Set whether the artist uses clipping.
When False artists will be visible outside of the axes which can lead to unexpected results.
Set the artist's clip path.
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.
For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.
For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.
Set the colormap for luminance data.
Set the edgecolor(s) of the LineCollection.
Single color (all lines have same color), or a sequence of rgba tuples; if it is a sequence the lines will cycle through the sequence.
Set the edgecolor(s) of the LineCollection.
Single color (all lines have same color), or a sequence of rgba tuples; if it is a sequence the lines will cycle through the sequence.
Alias for set_linestyle.
Alias for set_edgecolor.
Set the edgecolor(s) of the collection.
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor.
Alias for set_edgecolor.
Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence.
If c is 'none', the patch will not be filled.
Alias for set_facecolor.
Alias for set_facecolor.
Set the Figure instance the artist belongs to.
Set the (group) id for the artist.
Set the hatching pattern
hatch can be one of:
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Hatching is supported in the PostScript, PDF, SVG and Agg backends only.
Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member.
Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
Set the JoinStyle for the collection (for all its elements).
Set a label that will be displayed in the legend.
s will be converted to a string by calling str.
Set the linestyle(s) for the collection.
linestyle
description
'-' or 'solid'
solid line
'--' or 'dashed'
dashed line
'-.' or 'dashdot'
dash-dotted line
':' or 'dotted'
dotted line
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.
Alias for set_linestyle.
Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence
Alias for set_linewidth.
Alias for set_linestyle.
Alias for set_linewidth.
Set the normalization instance.
If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default.
Set the artist offset transform.
Set the offsets for the collection.
Set the path effects.
Define the picking behavior of the artist.
This can be one of the following:
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.
Set the pick radius used for containment tests.
Pick radius, in points.
Force rasterized (bitmap) drawing for vector graphics output.
Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.
This setting is ignored for pixel-based output.
See also Rasterization for vector graphics.
Set the sketch parameters.
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
The length of the wiggle along the line, in pixels (default 128.0)
The scale factor by which the length is shrunken or expanded (default 16.0)
The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.
Set the snapping behavior.
Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.
Snapping is currently only supported by the Agg and MacOSX backends.
Possible values:
Set the artist transform.
Set the url for the artist.
URLs are currently only implemented by the SVG backend. They are ignored by all other backends.
Set the artist's visibility.
Set the zorder for the artist. Artists with lower zorder values are drawn first.
Whether the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.
x and y sticky edge lists for autoscaling.
When performing autoscaling, if a data limit coincides with a value in the corresponding sticky_edges list, then no margin will be added--the view limit "sticks" to the edge. A typical use case is histograms, where one usually expects no margin on the bottom edge (0) of the histogram.
Moreover, margin expansion "bumps" against sticky edges and cannot cross them. For example, if the upper data limit is 1.0, the upper view limit computed by simple margin application is 1.2, but there is a sticky edge at 1.1, then the actual upper view limit will be 1.1.
This attribute cannot be assigned to; however, the x and y lists can be modified in place as needed.
Return a normalized rgba array corresponding to x.
In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable.
There is one special case, for handling images that are already rgb or rgba, such as might have been read from an image file. If x is an ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an rgb or rgba array, and no mapping will be done. The array can be uint8, or it can be floating point with values in the 0-1 range; otherwise a ValueError will be raised. If it is a masked array, the mask will be ignored. If the last dimension is 3, the alpha kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the alpha kwarg is ignored; it does not replace the pre-existing alpha. A ValueError will be raised if the third dimension is other than 3 or 4.
In either case, if bytes is False (default), the rgba array will be floats in the 0-1 range; if it is True, the returned rgba array will be uint8 in the 0 to 255 range.
If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1).
Update this artist's properties from the dict props.
Copy properties from other to self.
Update colors from the scalar mappable array, if any.
Assign colors to edges and faces based on the array and/or colors that were directly set, as appropriate.


Add a callback function that will be called whenever one of the Artist's properties changes.
The callback function. It must have the signature:
where artist is the calling Artist. Return values may exist but are ignored.
The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.
See also


Autoscale the scalar limits on the norm instance using the current array


Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None


Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.


The last colorbar associated with this ScalarMappable. May be None.


Test whether the mouse event occurred in the collection.
Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.


Convert x using the unit type of the xaxis.
If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.


Convert y using the unit type of the yaxis.
If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.


Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.


Find artist objects.
Recursively find all Artist instances contained in the artist.
A filter criterion for the matches. This can be
Include self in the list to be checked for a match.


Return a string representation of data.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.
See also


Return filter function to be used for agg filter.


Return the alpha value used for blending - not supported on all backends.


Return the array of values, that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array.


Return a list of the child Artists of this Artist.


Return the values (min, max) that are mapped to the colormap limits.


Return whether the artist uses clipping.


Return the cursor data for a given event.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.
Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation.
The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.
See also


Return the Figure instance the artist belongs to.


Return boolean flag, True if artist is included in layout calculations.
E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').


Return the label used for this artist in the legend.


Return the Transform instance used by this artist offset.


Return the picking behavior of the artist.
The possible values are described in set_picker.
See also


Return whether the artist is to be rasterized.


List of segments in the LineCollection. Each list item contains an array of vertices.


Return the sketch parameters for the artist.
A 3-tuple with the following elements:
Returns None if no sketch parameters were set.


Return the snap setting.
See set_snap for details.


Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).


Return the Transform instance used by this artist.


Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.


Return a list of URLs, one for each element of the collection.
The list contains None for elements without a URL. See Hyperlinks for an example.


Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.


Return whether units are set on any axis.


Return whether the Artist has an explicitly set transform.
This is True after set_transform has been called.


Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also


Process a pick event.
Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.
See also


Return whether the artist is pickable.
See also


Return a dictionary of all the properties of the artist.


Remove the artist from the figure if possible.
The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired.
Note: relim will not see collections even if the collection was added to the axes with autolim = True.
Note: there is no support for removing the artist's legend entry.


Remove a callback based on its observer id.
See also


Set multiple properties at once.
Supported properties are
Property
Description
agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha
array-like or scalar or None
animated
bool
antialiased or aa or antialiaseds
bool or list of bools
array
array-like or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clim
(vmin: float, vmax: float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
cmap
Colormap or str or None
color
color or list of colors
colors
color or list of colors
edgecolor or ec or edgecolors
color or list of colors or 'face'
facecolor or facecolors or fc
color or list of colors
figure
Figure
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle or dashes or linestyles or ls
str or tuple or list thereof
linewidth or linewidths or lw
float or list of floats
norm
Normalize or None
offset_transform
Transform
offsets
(N, 2) or (2,) array-like
path_effects
AbstractPathEffect
paths
unknown
picker
None or bool or float or callable
pickradius
float
rasterized
bool
segments
unknown
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
urls
list of str or None
verts
unknown
visible
bool
zorder
float


Set the agg filter.
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.


Set the alpha value used for blending - not supported on all backends.
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported.


Set whether the artist is intended to be used in an animation.
If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.
See also matplotlib.animation and Faster rendering by using blitting.


Set the antialiasing state for rendering.


Set the value array from array-like A.
The values that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A.


Set the CapStyle for the collection (for all its elements).


Set the norm limits for image scaling.
The limits.
The limits may also be passed as a tuple (vmin, vmax) as a single positional argument.


Set whether the artist uses clipping.
When False artists will be visible outside of the axes which can lead to unexpected results.


Set the artist's clip path.
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.
For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.
For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.


Set the edgecolor(s) of the LineCollection.
Single color (all lines have same color), or a sequence of rgba tuples; if it is a sequence the lines will cycle through the sequence.


Set the edgecolor(s) of the collection.
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor.


Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence.
If c is 'none', the patch will not be filled.


Set the Figure instance the artist belongs to.


Set the hatching pattern
hatch can be one of:
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Hatching is supported in the PostScript, PDF, SVG and Agg backends only.
Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member.


Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').


Set the JoinStyle for the collection (for all its elements).


Set a label that will be displayed in the legend.
s will be converted to a string by calling str.


Set the linestyle(s) for the collection.
linestyle
description
'-' or 'solid'
solid line
'--' or 'dashed'
dashed line
'-.' or 'dashdot'
dash-dotted line
':' or 'dotted'
dotted line
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.


Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence


Set the normalization instance.
If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default.


Define the picking behavior of the artist.
This can be one of the following:
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.


Set the pick radius used for containment tests.
Pick radius, in points.


Force rasterized (bitmap) drawing for vector graphics output.
Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.
This setting is ignored for pixel-based output.
See also Rasterization for vector graphics.


Set the sketch parameters.
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
The length of the wiggle along the line, in pixels (default 128.0)
The scale factor by which the length is shrunken or expanded (default 16.0)
The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.


Set the snapping behavior.
Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.
Snapping is currently only supported by the Agg and MacOSX backends.
Possible values:


URLs are currently only implemented by the SVG backend. They are ignored by all other backends.


Set the zorder for the artist. Artists with lower zorder values are drawn first.


Return a normalized rgba array corresponding to x.
In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable.
There is one special case, for handling images that are already rgb or rgba, such as might have been read from an image file. If x is an ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an rgb or rgba array, and no mapping will be done. The array can be uint8, or it can be floating point with values in the 0-1 range; otherwise a ValueError will be raised. If it is a masked array, the mask will be ignored. If the last dimension is 3, the alpha kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the alpha kwarg is ignored; it does not replace the pre-existing alpha. A ValueError will be raised if the third dimension is other than 3 or 4.
In either case, if bytes is False (default), the rgba array will be floats in the 0-1 range; if it is True, the returned rgba array will be uint8 in the 0 to 255 range.
If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1).


Update this artist's properties from the dict props.


Update colors from the scalar mappable array, if any.
Assign colors to edges and faces based on the array and/or colors that were directly set, as appropriate.


Bases: matplotlib.collections.Collection
A generic collection of patches.
This makes it easier to assign a colormap to a heterogeneous collection of patches.
This also may improve plotting speed, since PatchCollection will draw faster than a large number of patches.
a sequence of Patch objects. This list may include a heterogeneous assortment of different patch types.
If True, use the colors and linewidths of the original patches. If False, new colors may be assigned by providing the standard collection arguments, facecolor, edgecolor, linewidths, norm or cmap.
If any of edgecolors, facecolors, linewidths, antialiaseds are None, they default to their rcParams patch setting, in sequence form.
The use of ScalarMappable functionality is optional. If the ScalarMappable matrix _A has been set (via a call to set_array), at draw time a call to scalar mappable will be made to set the face colors.
Add a callback function that will be called whenever one of the Artist's properties changes.
The callback function. It must have the signature:
where artist is the calling Artist. Return values may exist but are ignored.
The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.
See also
Autoscale the scalar limits on the norm instance using the current array
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
The Axes instance the artist resides in, or None.
Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.
The last colorbar associated with this ScalarMappable. May be None.
Test whether the mouse event occurred in the collection.
Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.
Convert x using the unit type of the xaxis.
If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.
Convert y using the unit type of the yaxis.
If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.
Find artist objects.
Recursively find all Artist instances contained in the artist.
A filter criterion for the matches. This can be
Include self in the list to be checked for a match.
Return a string representation of data.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.
See also
Return filter function to be used for agg filter.
Return the alpha value used for blending - not supported on all backends.
Return whether the artist is animated.
Return the array of values, that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array.
Return a list of the child Artists of this Artist.
Return the values (min, max) that are mapped to the colormap limits.
Return the clipbox.
Return whether the artist uses clipping.
Return the clip path.
Return the Colormap instance.
Return the cursor data for a given event.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.
Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation.
The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.
See also
Alias for get_linestyle.
Alias for get_edgecolor.
Alias for get_edgecolor.
Alias for get_facecolor.
Alias for get_facecolor.
Return the Figure instance the artist belongs to.
Return whether face is colored.
Return the group id.
Return the current hatching pattern.
Return boolean flag, True if artist is included in layout calculations.
E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
Return the label used for this artist in the legend.
Alias for get_linestyle.
Alias for get_linewidth.
Alias for get_linestyle.
Alias for get_linewidth.
Return the Transform instance used by this artist offset.
Return the offsets for the collection.
Return the picking behavior of the artist.
The possible values are described in set_picker.
See also
Return whether the artist is to be rasterized.
Return the sketch parameters for the artist.
A 3-tuple with the following elements:
Returns None if no sketch parameters were set.
Return the snap setting.
See set_snap for details.
Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).
Return the Transform instance used by this artist.
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
Return the url.
Return a list of URLs, one for each element of the collection.
The list contains None for elements without a URL. See Hyperlinks for an example.
Return the visibility.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Return the artist's zorder.
Return whether units are set on any axis.
Return whether the Artist has an explicitly set transform.
This is True after set_transform has been called.
If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it.
See also get_cursor_data(), ToolCursorPosition and NavigationToolbar2.
Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also
Process a pick event.
Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.
See also
Return whether the artist is pickable.
See also
Return a dictionary of all the properties of the artist.
Remove the artist from the figure if possible.
The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired.
Note: relim will not see collections even if the collection was added to the axes with autolim = True.
Note: there is no support for removing the artist's legend entry.
Remove a callback based on its observer id.
See also
Set multiple properties at once.
Supported properties are
Property
Description
agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha
array-like or scalar or None
animated
bool
antialiased or aa or antialiaseds
bool or list of bools
array
array-like or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clim
(vmin: float, vmax: float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
cmap
Colormap or str or None
color
color or list of rgba tuples
edgecolor or ec or edgecolors
color or list of colors or 'face'
facecolor or facecolors or fc
color or list of colors
figure
Figure
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle or dashes or linestyles or ls
str or tuple or list thereof
linewidth or linewidths or lw
float or list of floats
norm
Normalize or None
offset_transform
Transform
offsets
(N, 2) or (2,) array-like
path_effects
AbstractPathEffect
paths
unknown
picker
None or bool or float or callable
pickradius
float
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
urls
list of str or None
visible
bool
zorder
float
Alias for set_antialiased.
Set the agg filter.
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.
Set the alpha value used for blending - not supported on all backends.
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported.
Set whether the artist is intended to be used in an animation.
If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.
See also matplotlib.animation and Faster rendering by using blitting.
Set the antialiasing state for rendering.
Alias for set_antialiased.
Set the value array from array-like A.
The values that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A.
Set the CapStyle for the collection (for all its elements).
Set the norm limits for image scaling.
The limits.
The limits may also be passed as a tuple (vmin, vmax) as a single positional argument.
Set the artist's clip Bbox.
Set whether the artist uses clipping.
When False artists will be visible outside of the axes which can lead to unexpected results.
Set the artist's clip path.
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.
For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.
For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.
Set the colormap for luminance data.
Set both the edgecolor and the facecolor.
See also
For setting the edge or face color individually.
Alias for set_linestyle.
Alias for set_edgecolor.
Set the edgecolor(s) of the collection.
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor.
Alias for set_edgecolor.
Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence.
If c is 'none', the patch will not be filled.
Alias for set_facecolor.
Alias for set_facecolor.
Set the Figure instance the artist belongs to.
Set the (group) id for the artist.
Set the hatching pattern
hatch can be one of:
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Hatching is supported in the PostScript, PDF, SVG and Agg backends only.
Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member.
Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
Set the JoinStyle for the collection (for all its elements).
Set a label that will be displayed in the legend.
s will be converted to a string by calling str.
Set the linestyle(s) for the collection.
linestyle
description
'-' or 'solid'
solid line
'--' or 'dashed'
dashed line
'-.' or 'dashdot'
dash-dotted line
':' or 'dotted'
dotted line
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.
Alias for set_linestyle.
Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence
Alias for set_linewidth.
Alias for set_linestyle.
Alias for set_linewidth.
Set the normalization instance.
If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default.
Set the artist offset transform.
Set the offsets for the collection.
Set the path effects.
Define the picking behavior of the artist.
This can be one of the following:
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.
Set the pick radius used for containment tests.
Pick radius, in points.
Force rasterized (bitmap) drawing for vector graphics output.
Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.
This setting is ignored for pixel-based output.
See also Rasterization for vector graphics.
Set the sketch parameters.
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
The length of the wiggle along the line, in pixels (default 128.0)
The scale factor by which the length is shrunken or expanded (default 16.0)
The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.
Set the snapping behavior.
Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.
Snapping is currently only supported by the Agg and MacOSX backends.
Possible values:
Set the artist transform.
Set the url for the artist.
URLs are currently only implemented by the SVG backend. They are ignored by all other backends.
Set the artist's visibility.
Set the zorder for the artist. Artists with lower zorder values are drawn first.
Whether the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.
x and y sticky edge lists for autoscaling.
When performing autoscaling, if a data limit coincides with a value in the corresponding sticky_edges list, then no margin will be added--the view limit "sticks" to the edge. A typical use case is histograms, where one usually expects no margin on the bottom edge (0) of the histogram.
Moreover, margin expansion "bumps" against sticky edges and cannot cross them. For example, if the upper data limit is 1.0, the upper view limit computed by simple margin application is 1.2, but there is a sticky edge at 1.1, then the actual upper view limit will be 1.1.
This attribute cannot be assigned to; however, the x and y lists can be modified in place as needed.
Return a normalized rgba array corresponding to x.
In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable.
There is one special case, for handling images that are already rgb or rgba, such as might have been read from an image file. If x is an ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an rgb or rgba array, and no mapping will be done. The array can be uint8, or it can be floating point with values in the 0-1 range; otherwise a ValueError will be raised. If it is a masked array, the mask will be ignored. If the last dimension is 3, the alpha kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the alpha kwarg is ignored; it does not replace the pre-existing alpha. A ValueError will be raised if the third dimension is other than 3 or 4.
In either case, if bytes is False (default), the rgba array will be floats in the 0-1 range; if it is True, the returned rgba array will be uint8 in the 0 to 255 range.
If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1).
Update this artist's properties from the dict props.
Copy properties from other to self.
Update colors from the scalar mappable array, if any.
Assign colors to edges and faces based on the array and/or colors that were directly set, as appropriate.


Add a callback function that will be called whenever one of the Artist's properties changes.
The callback function. It must have the signature:
where artist is the calling Artist. Return values may exist but are ignored.
The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.
See also


Autoscale the scalar limits on the norm instance using the current array


Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None


Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.


The last colorbar associated with this ScalarMappable. May be None.


Test whether the mouse event occurred in the collection.
Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.


Convert x using the unit type of the xaxis.
If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.


Convert y using the unit type of the yaxis.
If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.


Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.


Find artist objects.
Recursively find all Artist instances contained in the artist.
A filter criterion for the matches. This can be
Include self in the list to be checked for a match.


Return a string representation of data.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.
See also


Return filter function to be used for agg filter.


Return the alpha value used for blending - not supported on all backends.


Return the array of values, that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array.


Return a list of the child Artists of this Artist.


Return the values (min, max) that are mapped to the colormap limits.


Return whether the artist uses clipping.


Return the cursor data for a given event.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.
Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation.
The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.
See also


Return the Figure instance the artist belongs to.


Return boolean flag, True if artist is included in layout calculations.
E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').


Return the label used for this artist in the legend.


Return the Transform instance used by this artist offset.


Return the picking behavior of the artist.
The possible values are described in set_picker.
See also


Return whether the artist is to be rasterized.


Return the sketch parameters for the artist.
A 3-tuple with the following elements:
Returns None if no sketch parameters were set.


Return the snap setting.
See set_snap for details.


Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).


Return the Transform instance used by this artist.


Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.


Return a list of URLs, one for each element of the collection.
The list contains None for elements without a URL. See Hyperlinks for an example.


Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.


Return whether units are set on any axis.


Return whether the Artist has an explicitly set transform.
This is True after set_transform has been called.


Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also


Process a pick event.
Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.
See also


Return whether the artist is pickable.
See also


Return a dictionary of all the properties of the artist.


Remove the artist from the figure if possible.
The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired.
Note: relim will not see collections even if the collection was added to the axes with autolim = True.
Note: there is no support for removing the artist's legend entry.


Remove a callback based on its observer id.
See also


Set multiple properties at once.
Supported properties are
Property
Description
agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha
array-like or scalar or None
animated
bool
antialiased or aa or antialiaseds
bool or list of bools
array
array-like or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clim
(vmin: float, vmax: float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
cmap
Colormap or str or None
color
color or list of rgba tuples
edgecolor or ec or edgecolors
color or list of colors or 'face'
facecolor or facecolors or fc
color or list of colors
figure
Figure
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle or dashes or linestyles or ls
str or tuple or list thereof
linewidth or linewidths or lw
float or list of floats
norm
Normalize or None
offset_transform
Transform
offsets
(N, 2) or (2,) array-like
path_effects
AbstractPathEffect
paths
unknown
picker
None or bool or float or callable
pickradius
float
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
urls
list of str or None
visible
bool
zorder
float


Set the agg filter.
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.


Set the alpha value used for blending - not supported on all backends.
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported.


Set whether the artist is intended to be used in an animation.
If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.
See also matplotlib.animation and Faster rendering by using blitting.


Set the antialiasing state for rendering.


Set the value array from array-like A.
The values that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A.


Set the CapStyle for the collection (for all its elements).


Set the norm limits for image scaling.
The limits.
The limits may also be passed as a tuple (vmin, vmax) as a single positional argument.


Set whether the artist uses clipping.
When False artists will be visible outside of the axes which can lead to unexpected results.


Set the artist's clip path.
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.
For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.
For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.


Set both the edgecolor and the facecolor.
See also
For setting the edge or face color individually.


Set the edgecolor(s) of the collection.
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor.


Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence.
If c is 'none', the patch will not be filled.


Set the Figure instance the artist belongs to.


Set the hatching pattern
hatch can be one of:
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Hatching is supported in the PostScript, PDF, SVG and Agg backends only.
Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member.


Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').


Set the JoinStyle for the collection (for all its elements).


Set a label that will be displayed in the legend.
s will be converted to a string by calling str.


Set the linestyle(s) for the collection.
linestyle
description
'-' or 'solid'
solid line
'--' or 'dashed'
dashed line
'-.' or 'dashdot'
dash-dotted line
':' or 'dotted'
dotted line
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.


Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence


Set the normalization instance.
If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default.


Define the picking behavior of the artist.
This can be one of the following:
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.


Set the pick radius used for containment tests.
Pick radius, in points.


Force rasterized (bitmap) drawing for vector graphics output.
Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.
This setting is ignored for pixel-based output.
See also Rasterization for vector graphics.


Set the sketch parameters.
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
The length of the wiggle along the line, in pixels (default 128.0)
The scale factor by which the length is shrunken or expanded (default 16.0)
The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.


Set the snapping behavior.
Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.
Snapping is currently only supported by the Agg and MacOSX backends.
Possible values:


URLs are currently only implemented by the SVG backend. They are ignored by all other backends.


Set the zorder for the artist. Artists with lower zorder values are drawn first.


Return a normalized rgba array corresponding to x.
In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable.
There is one special case, for handling images that are already rgb or rgba, such as might have been read from an image file. If x is an ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an rgb or rgba array, and no mapping will be done. The array can be uint8, or it can be floating point with values in the 0-1 range; otherwise a ValueError will be raised. If it is a masked array, the mask will be ignored. If the last dimension is 3, the alpha kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the alpha kwarg is ignored; it does not replace the pre-existing alpha. A ValueError will be raised if the third dimension is other than 3 or 4.
In either case, if bytes is False (default), the rgba array will be floats in the 0-1 range; if it is True, the returned rgba array will be uint8 in the 0 to 255 range.
If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1).


Update this artist's properties from the dict props.


Update colors from the scalar mappable array, if any.
Assign colors to edges and faces based on the array and/or colors that were directly set, as appropriate.


Bases: matplotlib.collections._CollectionWithSizes
A collection of Paths, as created by e.g. scatter.
The paths that will make up the Collection.
The factor by which to scale each drawn Path. One unit squared in the Path's data space is scaled to be sizes**2 points when rendered.
Forwarded to Collection.
Add a callback function that will be called whenever one of the Artist's properties changes.
The callback function. It must have the signature:
where artist is the calling Artist. Return values may exist but are ignored.
The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.
See also
Autoscale the scalar limits on the norm instance using the current array
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
The Axes instance the artist resides in, or None.
Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.
The last colorbar associated with this ScalarMappable. May be None.
Test whether the mouse event occurred in the collection.
Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.
Convert x using the unit type of the xaxis.
If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.
Convert y using the unit type of the yaxis.
If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.
Find artist objects.
Recursively find all Artist instances contained in the artist.
A filter criterion for the matches. This can be
Include self in the list to be checked for a match.
Return a string representation of data.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.
See also
Return filter function to be used for agg filter.
Return the alpha value used for blending - not supported on all backends.
Return whether the artist is animated.
Return the array of values, that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array.
Return a list of the child Artists of this Artist.
Return the values (min, max) that are mapped to the colormap limits.
Return the clipbox.
Return whether the artist uses clipping.
Return the clip path.
Return the Colormap instance.
Return the cursor data for a given event.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.
Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation.
The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.
See also
Alias for get_linestyle.
Alias for get_edgecolor.
Alias for get_edgecolor.
Alias for get_facecolor.
Alias for get_facecolor.
Return the Figure instance the artist belongs to.
Return whether face is colored.
Return the group id.
Return the current hatching pattern.
Return boolean flag, True if artist is included in layout calculations.
E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
Return the label used for this artist in the legend.
Alias for get_linestyle.
Alias for get_linewidth.
Alias for get_linestyle.
Alias for get_linewidth.
Return the Transform instance used by this artist offset.
Return the offsets for the collection.
Return the picking behavior of the artist.
The possible values are described in set_picker.
See also
Return whether the artist is to be rasterized.
Return the sizes ('areas') of the elements in the collection.
The 'area' of each element.
Return the sketch parameters for the artist.
A 3-tuple with the following elements:
Returns None if no sketch parameters were set.
Return the snap setting.
See set_snap for details.
Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).
Return the Transform instance used by this artist.
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
Return the url.
Return a list of URLs, one for each element of the collection.
The list contains None for elements without a URL. See Hyperlinks for an example.
Return the visibility.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Return the artist's zorder.
Return whether units are set on any axis.
Return whether the Artist has an explicitly set transform.
This is True after set_transform has been called.
Create legend handles and labels for a PathCollection.
Each legend handle is a Line2D representing the Path that was drawn, and each label is a string what each Path represents.
This is useful for obtaining a legend for a scatter plot; e.g.:
creates three legend elements, one for each color with the numerical values passed to c as the labels.
Also see the Automated legend creation example.
If "colors", the legend handles will show the different colors of the collection. If "sizes", the legend will show the different sizes. To set both, use kwargs to directly edit the Line2D properties.
Target number of elements to create. If None, use all unique elements of the mappable array. If an integer, target to use num elements in the normed range. If "auto", try to determine which option better suits the nature of the data. The number of created elements may slightly deviate from num due to a Locator being used to find useful locations. If a list or array, use exactly those elements for the legend. Finally, a Locator can be provided.
The format or formatter to use for the labels. If a string must be a valid input for a StrMethodFormatter. If None (the default), use a ScalarFormatter.
Function to calculate the labels. Often the size (or color) argument to scatter will have been pre-processed by the user using a function s = f(x) to make the markers visible; e.g. size = np.log10(x). Providing the inverse of this function here allows that pre-processing to be inverted, so that the legend labels have the correct values; e.g. func = lambda
x: 10**x.
Allowed keyword arguments are color and size. E.g. it may be useful to set the color of the markers if prop="sizes" is used; similarly to set the size of the markers if prop="colors" is used. Any further parameters are passed onto the Line2D instance. This may be useful to e.g. specify a different markeredgecolor or alpha for the legend handles.
Visual representation of each element of the legend.
The string labels for elements of the legend.
If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it.
See also get_cursor_data(), ToolCursorPosition and NavigationToolbar2.
Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also
Process a pick event.
Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.
See also
Return whether the artist is pickable.
See also
Return a dictionary of all the properties of the artist.
Remove the artist from the figure if possible.
The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired.
Note: relim will not see collections even if the collection was added to the axes with autolim = True.
Note: there is no support for removing the artist's legend entry.
Remove a callback based on its observer id.
See also
Set multiple properties at once.
Supported properties are
Property
Description
agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha
array-like or scalar or None
animated
bool
antialiased or aa or antialiaseds
bool or list of bools
array
array-like or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clim
(vmin: float, vmax: float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
cmap
Colormap or str or None
color
color or list of rgba tuples
edgecolor or ec or edgecolors
color or list of colors or 'face'
facecolor or facecolors or fc
color or list of colors
figure
Figure
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle or dashes or linestyles or ls
str or tuple or list thereof
linewidth or linewidths or lw
float or list of floats
norm
Normalize or None
offset_transform
Transform
offsets
(N, 2) or (2,) array-like
path_effects
AbstractPathEffect
paths
unknown
picker
None or bool or float or callable
pickradius
float
rasterized
bool
sizes
ndarray or None
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
urls
list of str or None
visible
bool
zorder
float
Alias for set_antialiased.
Set the agg filter.
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.
Set the alpha value used for blending - not supported on all backends.
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported.
Set whether the artist is intended to be used in an animation.
If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.
See also matplotlib.animation and Faster rendering by using blitting.
Set the antialiasing state for rendering.
Alias for set_antialiased.
Set the value array from array-like A.
The values that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A.
Set the CapStyle for the collection (for all its elements).
Set the norm limits for image scaling.
The limits.
The limits may also be passed as a tuple (vmin, vmax) as a single positional argument.
Set the artist's clip Bbox.
Set whether the artist uses clipping.
When False artists will be visible outside of the axes which can lead to unexpected results.
Set the artist's clip path.
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.
For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.
For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.
Set the colormap for luminance data.
Set both the edgecolor and the facecolor.
See also
For setting the edge or face color individually.
Alias for set_linestyle.
Alias for set_edgecolor.
Set the edgecolor(s) of the collection.
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor.
Alias for set_edgecolor.
Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence.
If c is 'none', the patch will not be filled.
Alias for set_facecolor.
Alias for set_facecolor.
Set the Figure instance the artist belongs to.
Set the (group) id for the artist.
Set the hatching pattern
hatch can be one of:
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Hatching is supported in the PostScript, PDF, SVG and Agg backends only.
Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member.
Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').
Set the JoinStyle for the collection (for all its elements).
Set a label that will be displayed in the legend.
s will be converted to a string by calling str.
Set the linestyle(s) for the collection.
linestyle
description
'-' or 'solid'
solid line
'--' or 'dashed'
dashed line
'-.' or 'dashdot'
dash-dotted line
':' or 'dotted'
dotted line
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.
Alias for set_linestyle.
Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence
Alias for set_linewidth.
Alias for set_linestyle.
Alias for set_linewidth.
Set the normalization instance.
If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default.
Set the artist offset transform.
Set the offsets for the collection.
Set the path effects.
Define the picking behavior of the artist.
This can be one of the following:
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.
Set the pick radius used for containment tests.
Pick radius, in points.
Force rasterized (bitmap) drawing for vector graphics output.
Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.
This setting is ignored for pixel-based output.
See also Rasterization for vector graphics.
Set the sizes of each member of the collection.
The size to set for each element of the collection. The value is the 'area' of the element.
The dpi of the canvas.
Set the sketch parameters.
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
The length of the wiggle along the line, in pixels (default 128.0)
The scale factor by which the length is shrunken or expanded (default 16.0)
The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.
Set the snapping behavior.
Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.
Snapping is currently only supported by the Agg and MacOSX backends.
Possible values:
Set the artist transform.
Set the url for the artist.
URLs are currently only implemented by the SVG backend. They are ignored by all other backends.
Set the artist's visibility.
Set the zorder for the artist. Artists with lower zorder values are drawn first.
Whether the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.
x and y sticky edge lists for autoscaling.
When performing autoscaling, if a data limit coincides with a value in the corresponding sticky_edges list, then no margin will be added--the view limit "sticks" to the edge. A typical use case is histograms, where one usually expects no margin on the bottom edge (0) of the histogram.
Moreover, margin expansion "bumps" against sticky edges and cannot cross them. For example, if the upper data limit is 1.0, the upper view limit computed by simple margin application is 1.2, but there is a sticky edge at 1.1, then the actual upper view limit will be 1.1.
This attribute cannot be assigned to; however, the x and y lists can be modified in place as needed.
Return a normalized rgba array corresponding to x.
In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable.
There is one special case, for handling images that are already rgb or rgba, such as might have been read from an image file. If x is an ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an rgb or rgba array, and no mapping will be done. The array can be uint8, or it can be floating point with values in the 0-1 range; otherwise a ValueError will be raised. If it is a masked array, the mask will be ignored. If the last dimension is 3, the alpha kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the alpha kwarg is ignored; it does not replace the pre-existing alpha. A ValueError will be raised if the third dimension is other than 3 or 4.
In either case, if bytes is False (default), the rgba array will be floats in the 0-1 range; if it is True, the returned rgba array will be uint8 in the 0 to 255 range.
If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1).
Update this artist's properties from the dict props.
Copy properties from other to self.
Update colors from the scalar mappable array, if any.
Assign colors to edges and faces based on the array and/or colors that were directly set, as appropriate.


Add a callback function that will be called whenever one of the Artist's properties changes.
The callback function. It must have the signature:
where artist is the calling Artist. Return values may exist but are ignored.
The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.
See also


Autoscale the scalar limits on the norm instance using the current array


Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None


Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.


The last colorbar associated with this ScalarMappable. May be None.


Test whether the mouse event occurred in the collection.
Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.


Convert x using the unit type of the xaxis.
If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.


Convert y using the unit type of the yaxis.
If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.


Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.


Find artist objects.
Recursively find all Artist instances contained in the artist.
A filter criterion for the matches. This can be
Include self in the list to be checked for a match.


Return a string representation of data.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter.
See also


Return filter function to be used for agg filter.


Return the alpha value used for blending - not supported on all backends.


Return the array of values, that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array.


Return a list of the child Artists of this Artist.


Return the values (min, max) that are mapped to the colormap limits.


Return whether the artist uses clipping.


Return the cursor data for a given event.
Note
This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.
Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.
Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation.
The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse.
See also


Return the Figure instance the artist belongs to.


Return boolean flag, True if artist is included in layout calculations.
E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').


Return the label used for this artist in the legend.


Return the Transform instance used by this artist offset.


Return the picking behavior of the artist.
The possible values are described in set_picker.
See also


Return whether the artist is to be rasterized.


Return the sizes ('areas') of the elements in the collection.
The 'area' of each element.


Return the sketch parameters for the artist.
A 3-tuple with the following elements:
Returns None if no sketch parameters were set.


Return the snap setting.
See set_snap for details.


Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).


Return the Transform instance used by this artist.


Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.


Return a list of URLs, one for each element of the collection.
The list contains None for elements without a URL. See Hyperlinks for an example.


Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.


Return whether units are set on any axis.


Return whether the Artist has an explicitly set transform.
This is True after set_transform has been called.


Create legend handles and labels for a PathCollection.
Each legend handle is a Line2D representing the Path that was drawn, and each label is a string what each Path represents.
This is useful for obtaining a legend for a scatter plot; e.g.:
creates three legend elements, one for each color with the numerical values passed to c as the labels.
Also see the Automated legend creation example.
If "colors", the legend handles will show the different colors of the collection. If "sizes", the legend will show the different sizes. To set both, use kwargs to directly edit the Line2D properties.
Target number of elements to create. If None, use all unique elements of the mappable array. If an integer, target to use num elements in the normed range. If "auto", try to determine which option better suits the nature of the data. The number of created elements may slightly deviate from num due to a Locator being used to find useful locations. If a list or array, use exactly those elements for the legend. Finally, a Locator can be provided.
The format or formatter to use for the labels. If a string must be a valid input for a StrMethodFormatter. If None (the default), use a ScalarFormatter.
Function to calculate the labels. Often the size (or color) argument to scatter will have been pre-processed by the user using a function s = f(x) to make the markers visible; e.g. size = np.log10(x). Providing the inverse of this function here allows that pre-processing to be inverted, so that the legend labels have the correct values; e.g. func = lambda
x: 10**x.
Allowed keyword arguments are color and size. E.g. it may be useful to set the color of the markers if prop="sizes" is used; similarly to set the size of the markers if prop="colors" is used. Any further parameters are passed onto the Line2D instance. This may be useful to e.g. specify a different markeredgecolor or alpha for the legend handles.
Visual representation of each element of the legend.
The string labels for elements of the legend.


Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also


Process a pick event.
Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.
See also


Return whether the artist is pickable.
See also


Return a dictionary of all the properties of the artist.


Remove the artist from the figure if possible.
The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired.
Note: relim will not see collections even if the collection was added to the axes with autolim = True.
Note: there is no support for removing the artist's legend entry.


Remove a callback based on its observer id.
See also


Set multiple properties at once.
Supported properties are
Property
Description
agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha
array-like or scalar or None
animated
bool
antialiased or aa or antialiaseds
bool or list of bools
array
array-like or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clim
(vmin: float, vmax: float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
cmap
Colormap or str or None
color
color or list of rgba tuples
edgecolor or ec or edgecolors
color or list of colors or 'face'
facecolor or facecolors or fc
color or list of colors
figure
Figure
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle or dashes or linestyles or ls
str or tuple or list thereof
linewidth or linewidths or lw
float or list of floats
norm
Normalize or None
offset_transform
Transform
offsets
(N, 2) or (2,) array-like
path_effects
AbstractPathEffect
paths
unknown
picker
None or bool or float or callable
pickradius
float
rasterized
bool
sizes
ndarray or None
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
urls
list of str or None
visible
bool
zorder
float


Set the agg filter.
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.


Set the alpha value used for blending - not supported on all backends.
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported.


Set whether the artist is intended to be used in an animation.
If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.
See also matplotlib.animation and Faster rendering by using blitting.


Set the antialiasing state for rendering.


Set the value array from array-like A.
The values that are mapped to colors.
The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A.


Set the CapStyle for the collection (for all its elements).


Set the norm limits for image scaling.
The limits.
The limits may also be passed as a tuple (vmin, vmax) as a single positional argument.


Set whether the artist uses clipping.
When False artists will be visible outside of the axes which can lead to unexpected results.


Set the artist's clip path.
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform.
For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.
For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter.


Set both the edgecolor and the facecolor.
See also
For setting the edge or face color individually.


Set the edgecolor(s) of the collection.
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor.


Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence.
If c is 'none', the patch will not be filled.


Set the Figure instance the artist belongs to.


Set the hatching pattern
hatch can be one of:
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Hatching is supported in the PostScript, PDF, SVG and Agg backends only.
Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member.


Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').


Set the JoinStyle for the collection (for all its elements).


Set a label that will be displayed in the legend.
s will be converted to a string by calling str.


Set the linestyle(s) for the collection.
linestyle
description
'-' or 'solid'
solid line
'--' or 'dashed'
dashed line
'-.' or 'dashdot'
dash-dotted line
':' or 'dotted'
dotted line
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.


Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence


Set the normalization instance.
If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default.


Define the picking behavior of the artist.
This can be one of the following:
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.


Set the pick radius used for containment tests.
Pick radius, in points.


Force rasterized (bitmap) drawing for vector graphics output.
Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.
This setting is ignored for pixel-based output.
See also Rasterization for vector graphics.


Set the sizes of each member of the collection.
The size to set for each element of the collection. The value is the 'area' of the element.
The dpi of the canvas.


Set the sketch parameters.
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
The length of the wiggle along the line, in pixels (default 128.0)
The scale factor by which the length is shrunken or expanded (default 16.0)
The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.


Set the snapping behavior.
Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.
Snapping is currently only supported by the Agg and MacOSX backends.
Possible values:


URLs are currently only implemented by the SVG backend. They are ignored by all other backends.


Set the zorder for the artist. Artists with lower zorder values are drawn first.