Info
matplotlib.collections
Up one level
Classes for the efficient drawing of large collections of objects that
share most properties, e.g. a large number of line segments or
polygons.
The classes are not meant to be as flexible as their single element
counterparts (e.g. you may not be able to select all line styles) but
they are meant to be fast for common use cases (e.g. a bunch of solid
line segemnts)
Packages
Modules
Classes
class AsteriskPolygonCollection
(
RegularPolyCollection
)
Draw a collection of regular asterisks with *numsides* points.
unit_regular_asterisk (cls, numVertices)
(staticmethod) Returns a :class:`Path` for a unit regular
asterisk with the given numVertices and radius of 1.0,
centered at (0, 0).
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class BrokenBarHCollection
(
PolyCollection
)
A collection of horizontal bars spanning *yrange* with a sequence of
*xranges*.
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_verts (self, verts, closed=True )
This allows one to delay initialization of the vertices.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class Collection
(
Artist
,
ScalarMappable
)
Base class for Collections. Must be subclassed to be usable.
All properties in a collection must be sequences or scalars;
if scalars, they will be converted to sequences. The
property of the ith element of the collection is::
prop[i % len(props)]
Keyword arguments and default values:
* *edgecolors*: None
* *facecolors*: None
* *linewidths*: None
* *antialiaseds*: None
* *offsets*: None
* *transOffset*: transforms.IdentityTransform()
* *norm*: None (optional for
:class:`matplotlib.cm.ScalarMappable`)
* *cmap*: None (optional for
:class:`matplotlib.cm.ScalarMappable`)
*offsets* and *transOffset* are used to translate the patch after
rendering (default no offsets).
If any of *edgecolors*, *facecolors*, *linewidths*, *antialiaseds*
are None, they default to their :data:`matplotlib.rcParams` patch
setting, in sequence form.
The use of :class:`~matplotlib.cm.ScalarMappable` is optional. If
the :class:`~matplotlib.cm.ScalarMappable` matrix _A is not None
(ie a call to set_array has been made), at draw time a call to
scalar mappable will be made to set the face colors.
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class LineCollection
(
Collection
)
All parameters must be sequences or scalars; if scalars, they will
be converted to sequences. The property of the ith line
segment is::
prop[i % len(props)]
i.e., the properties cycle if the ``len`` of props is less than the
number of segments.
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
color (self, c)
Set the color(s) of the line collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_color (self)
get_color (self)
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set the color(s) of the line collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_segments (self, segments)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_segments (self, segments)
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class PatchCollection
(
Collection
)
A generic collection of patches.
This makes it easier to assign a color map to a heterogeneous
collection of patches.
This also may improve plotting speed, since PatchCollection will
draw faster than a large number of patches.
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class PolyCollection
(
Collection
)
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_verts (self, verts, closed=True )
This allows one to delay initialization of the vertices.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class QuadMesh
(
Collection
)
Class for the efficient drawing of a quadrilateral mesh.
A quadrilateral mesh consists of a grid of vertices. The
dimensions of this array are (*meshWidth* + 1, *meshHeight* +
1). Each vertex in the mesh has a different set of "mesh
coordinates" representing its position in the topology of the
mesh. For any values (*m*, *n*) such that 0 <= *m* <= *meshWidth*
and 0 <= *n* <= *meshHeight*, the vertices at mesh coordinates
(*m*, *n*), (*m*, *n* + 1), (*m* + 1, *n* + 1), and (*m* + 1, *n*)
form one of the quadrilaterals in the mesh. There are thus
(*meshWidth* * *meshHeight*) quadrilaterals in the mesh. The mesh
need not be regular and the polygons need not be convex.
A quadrilateral mesh is represented by a (2 x ((*meshWidth* + 1) *
(*meshHeight* + 1))) numpy array *coordinates*, where each row is
the *x* and *y* coordinates of one of the vertices. To define the
function that maps from a data point to its corresponding color,
use the :meth:`set_cmap` method. Each of these arrays is indexed in
row-major order by the mesh coordinates of the vertex (or the mesh
coordinates of the lower left vertex, in the case of the
colors).
For example, the first entry in *coordinates* is the
coordinates of the vertex at mesh coordinates (0, 0), then the one
at (0, 1), then at (0, 2) .. (0, meshWidth), (1, 0), (1, 1), and
so on.
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self, dataTrans=None )
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class RegularPolyCollection
(
Collection
)
Draw a collection of regular polygons with *numsides*.
unit_regular_polygon (cls, numVertices)
(staticmethod) Returns a :class:`Path` for a unit regular
polygon with the given numVertices and radius of 1.0, centered
at (0, 0).
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
class StarPolygonCollection
(
RegularPolyCollection
)
Draw a collection of regular stars with *numsides* points.
unit_regular_star (cls, numVertices, innerCircle=0.5 )
(staticmethod) Returns a :class:`Path` for a unit regular star
with the given numVertices and radius of 1.0, centered at (0,
0).
add_callback (self, func)
add_checker (self, checker)
Add an entry to a dictionary of boolean flags
that are set to True when the mappable is changed.
autoscale (self)
Autoscale the scalar limits on the norm instance using the
current array
autoscale_None (self)
Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None
changed (self)
Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal
check_update (self, checker)
If mappable has changed since the last check,
return True; else return False
contains (self, mouseevent)
Test whether the mouse event occurred in the collection.
Returns True | False, ``dict(ind=itemlist)``, where every
item in itemlist contains the event.
convert_xunits (self, x)
for artists in an axes, if the xaxis as units support,
convert x using xaxis unit type
convert_yunits (self, y)
for artists in an axes, if the yaxis as units support,
convert y using yaxis unit type
draw (self, renderer)
get_alpha (self)
Return the alpha value used for blending - not supported on all
backends
get_animated (self)
return the artist's animated state
get_array (self)
Return the array
get_axes (self)
return the axes instance the artist resides in, or None
get_clim (self)
return the min, max of the color limits for image scaling
get_clip_box (self)
Return artist clipbox
get_clip_on (self)
Return whether artist uses clipping
get_clip_path (self)
Return artist clip path
get_cmap (self)
return the colormap
get_contains (self)
return the _contains test used by the artist, or None for default.
get_linestyles (self)
get_datalim (self, transData)
get_edgecolor (self)
get_edgecolor (self)
get_facecolor (self)
get_facecolor (self)
get_figure (self)
Return the :class:`~matplotlib.figure.Figure` instance the
artist belongs to.
get_label (self)
get_linestyles (self)
get_linestyles (self)
get_linewidths (self)
get_linewidths (self)
get_paths (self)
get_picker (self)
return the Pickeration instance used by this artist
get_pickradius (self)
get_transform (self)
Return the :class:`~matplotlib.transforms.Transform`
instance used by this artist.
get_transformed_clip_path_and_affine (self)
Return the clip path with the non-affine part of its transformation applied,
and the remaining affine part of its transformation.
get_transforms (self)
get_visible (self)
return the artist's visiblity
get_zorder (self)
have_units (self)
return True if units are set on the x or y axes
hitlist (self, event)
List the children of the artist which contain the mouse event
is_figure_set (self)
is_transform_set (self)
Artist has transform explicity let
pchanged (self)
fire event when property changed
pick (self, mouseevent)
pick(mouseevent)
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
pickable (self)
return True if self is pickable
remove (self)
Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
:meth:`matplotlib.axes.Axes.draw_idle`. Call
:meth:`matplotlib.axes.Axes.relim` to update the axes limits
if desired.
Note: :meth:`~matplotlib.axes.Axes.relim` will not see
collections even if the collection was added to axes with
*autolim* = True.
Note: there is no support for removing the artist's legend entry.
remove_callback (self, oid)
set (self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha (self, alpha)
Set the alpha tranparencies of the collection. *alpha* must be
a float.
ACCEPTS: float
set_animated (self, b)
set the artist's animation state
ACCEPTS: [True | False]
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_antialiased (self, aa)
Set the antialiasing state for rendering.
ACCEPTS: Boolean or sequence of booleans
set_array (self, A)
Set the image array from numpy array *A*
set_axes (self, axes)
set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
set_clim (self, vmin=None , vmax=None )
set the norm limits for image scaling; if *vmin* is a length2
sequence, interpret it as ``(vmin, vmax)`` which is used to
support setp
ACCEPTS: a length 2 sequence of floats
set_clip_box (self, clipbox)
Set the artist's clip Bbox
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on (self, b)
Set whether artist uses clipping
ACCEPTS: [True | False]
set_clip_path (self, path, transform=None )
Set the artist's clip path, which may be:
a) a :class:`~matplotlib.patches.Patch` (or subclass) instance
b) a :class:`~matplotlib.path.Path` instance, in which case
an optional :class:`~matplotlib.transforms.Transform`
instance may be provided, which will be applied to the
path before using it for clipping.
c) *None*, to remove the clipping path
For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to *None*.
ACCEPTS: a Path instance and a Transform instance, a Patch
instance, or None
set_cmap (self, cmap)
set the colormap for luminance data
ACCEPTS: a colormap
set_color (self, c)
Set both the edgecolor and the facecolor.
See :meth:`set_facecolor` and :meth:`set_edgecolor`.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_colorbar (self, im, ax)
set the colorbar image and axes associated with mappable
set_contains (self, picker)
Replace the contains test used by this artist. The new picker should
be a callable function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
If the mouse event is over the artist, return hit=True and props
is a dictionary of properties you want returned with the contains test.
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor (self, c)
Set the edgecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor (self, c)
Set the facecolor(s) of the collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_figure (self, fig)
Set the :class:`~matplotlib.figure.Figure` instance the artist
belongs to.
ACCEPTS: a matplotlib.figure.Figure instance
set_label (self, s)
Set the line label to s for auto legend
ACCEPTS: any string
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linestyles (self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_lod (self, on)
Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
ACCEPTS: [True | False]
set_linewidths (self, lw)
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
ACCEPTS: float or sequence of floats
set_norm (self, norm)
set the normalization instance
set_picker (self, picker)
set the epsilon for picking used by this artist
picker can be one of the following:
None - picking is disabled for this artist (default)
boolean - if True then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist
float - if picker is a number it is interpreted as an
epsilon tolerance in points and the the artist will fire
off an event if it's data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, eg the indices of the data within
epsilon of the pick event
function - if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event::
hit, props = picker(artist, mouseevent)
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.
ACCEPTS: [None|float|boolean|callable]
set_pickradius (self, pickradius)
set_transform (self, t)
Set the :class:`~matplotlib.transforms.Transform` instance
used by this artist.
set_visible (self, b)
set the artist's visiblity
ACCEPTS: [True | False]
set_zorder (self, level)
Set the zorder for the artist
ACCEPTS: any number
to_rgba (self, x, alpha=1.0 , bytes=False )
Return a normalized rgba array corresponding to *x*. If *x*
is already an rgb array, insert *alpha*; if it is already
rgba, return it unchanged. If *bytes* is True, return rgba as
4 uint8s instead of 4 floats.
update (self, props)
update_from (self, other)
Copy properties from *other* to *self*.
update_scalarmappable (self)
If the scalar mappable array is not none, update colors
from scalar data
September
Mo Tu We Th Fr Sa Su
1 2 3 4 5
6 7 8 9 10 11 12
13 14 15 16 17 18 19
20 21 22 23 24 25 26
27 28 29 30
Forgot your password?
New user?
