| | |
- matplotlib.artist.Artist(__builtin__.object)
-
- Patch
-
- Arrow
- Ellipse
-
- Arc
- Circle
- PathPatch
- Polygon
-
- FancyArrow
- Rectangle
- RegularPolygon
-
- CirclePolygon
- Shadow
- Wedge
- YAArrow
class Arc(Ellipse) |
| |
An elliptical arc. Because it performs various optimizations, it
can not be filled.
The arc must be used in an Axes instance it cannot be added
directly to a Figure) because it is optimized to only render the
segments that are inside the axes bounding box with high
resolution.
|
| |
- Method resolution order:
- Arc
- Ellipse
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, width, height, angle=0.0, theta1=0.0, theta2=360.0, **kwargs)
- xy - center of ellipse
width - length of horizontal axis
height - length of vertical axis
angle - rotation in degrees (anti-clockwise)
theta1 - starting angle of the arc in degrees
theta2 - ending angle of the arc in degrees
If theta1 and theta2 are not provided, the arc will form a
complete ellipse.
Valid kwargs are:
%(Patch)s
- __str__(self)
- draw(self, renderer)
- Ellipses are normally drawn using an approximation that uses
eight cubic bezier splines. The error of this approximation
is 1.89818e-6, according to this unverified source:
Lancaster, Don. Approximating a Circle or an Ellipse Using
Four Bezier Cubic Splines.
http://www.tinaja.com/glib/ellipse4.pdf
There is a use case where very large ellipses must be drawn
with very high accuracy, and it is too expensive to render the
entire ellipse with enough segments (either splines or line
segments). Therefore, in the case where either radius of the
ellipse is large enough that the error of the spline
approximation will be visible (greater than one pixel offset
from the ideal), a different technique is used.
In that case, only the visible parts of the ellipse are drawn,
with each visible arc using a fixed number of spline segments
(8). The algorithm proceeds as follows:
1. The points where the ellipse intersects the axes bounding
box are located. (This is done be performing an inverse
transformation on the axes bbox such that it is relative to
the unit circle -- this makes the intersection calculation
much easier than doing rotated ellipse intersection
directly).
This uses the "line intersecting a circle" algorithm from:
Vince, John. Geometry for Computer Graphics: Formulae,
Examples & Proofs. London: Springer-Verlag, 2005.
2. The angles of each of the intersection points are
calculated.
3. Proceeding counterclockwise starting in the positive
x-direction, each of the visible arc-segments between the
pairs of vertices are drawn using the bezier arc
approximation technique implemented in Path.arc().
Methods inherited from Ellipse:
- contains(self, ev)
- get_patch_transform(self)
- get_path(self)
- Return the vertices of the rectangle
Methods inherited from Patch:
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Arrow(Patch) |
| |
An arrow patch
|
| |
- Method resolution order:
- Arrow
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, x, y, dx, dy, width=1.0, **kwargs)
- Draws an arrow, starting at (x,y), direction and length
given by (dx,dy) the width of the arrow is scaled by width
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
- get_patch_transform(self)
- get_path(self)
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Circle(Ellipse) |
| |
A circle patch
|
| |
- Method resolution order:
- Circle
- Ellipse
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, radius=5, **kwargs)
- Create true circle at center xy=(x,y) with given radius;
unlike circle polygon which is a polygonal approcimation, this
uses splines and is much closer to a scale free circle
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
Methods inherited from Ellipse:
- contains(self, ev)
- get_patch_transform(self)
- get_path(self)
- Return the vertices of the rectangle
Methods inherited from Patch:
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class CirclePolygon(RegularPolygon) |
| |
A circle patch
|
| |
- Method resolution order:
- CirclePolygon
- RegularPolygon
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, radius=5, resolution=20, **kwargs)
- Create a circle at xy=(x,y) with radius given by 'radius'
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
Methods inherited from RegularPolygon:
- get_patch_transform(self)
- get_path(self)
Data descriptors inherited from RegularPolygon:
- numvertices
- orientation
- radius
- xy
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Ellipse(Patch) |
| |
A scale-free ellipse
|
| |
- Method resolution order:
- Ellipse
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, width, height, angle=0.0, **kwargs)
- xy - center of ellipse
width - length of horizontal axis
height - length of vertical axis
angle - rotation in degrees (anti-clockwise)
Valid kwargs are:
%(Patch)s
- __str__(self)
- contains(self, ev)
- get_patch_transform(self)
- get_path(self)
- Return the vertices of the rectangle
Methods inherited from Patch:
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class FancyArrow(Polygon) |
| |
Like Arrow, but lets you set head width and head height independently.
|
| |
- Method resolution order:
- FancyArrow
- Polygon
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False, head_width=None, head_length=None, shape='full', overhang=0, head_starts_at_zero=False, **kwargs)
- Returns a new Arrow.
length_includes_head: True if head is counted in calculating the length.
shape: ['full', 'left', 'right']
overhang: distance that the arrow is swept back (0 overhang means
triangular shape).
head_starts_at_zero: if True, the head starts being drawn at coordinate
0 instead of ending at coordinate 0.
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
Methods inherited from Polygon:
- get_path(self)
Data descriptors inherited from Polygon:
- xy
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_patch_transform(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Patch(matplotlib.artist.Artist) |
| |
A patch is a 2D thingy with a face color and an edge color
If any of edgecolor, facecolor, linewidth, or antialiased are
None, they default to their rc params setting
|
| |
- Method resolution order:
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, edgecolor=None, facecolor=None, linewidth=None, antialiased=None, hatch=None, fill=True, **kwargs)
- The following kwarg properties are supported
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_patch_transform(self)
- get_path(self)
- Return the path of this patch
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- update_from(self, other)
Data and other attributes defined here:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class PathPatch(Patch) |
| |
A general polycurve path patch.
|
| |
- Method resolution order:
- PathPatch
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, path, **kwargs)
- path is a Path object
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
See Patch documentation for additional kwargs
- __str__(self)
- get_path(self)
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_patch_transform(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Polygon(Patch) |
| |
A general polygon patch.
|
| |
- Method resolution order:
- Polygon
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, **kwargs)
- xy is a numpy array with shape Nx2
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
See Patch documentation for additional kwargs
- __str__(self)
- get_path(self)
Data descriptors defined here:
- xy
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_patch_transform(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Rectangle(Patch) |
| |
Draw a rectangle with lower left at xy=(x,y) with specified
width and height
|
| |
- Method resolution order:
- Rectangle
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, width, height, **kwargs)
- xy is an x,y tuple lower, left
width and height are width and height of rectangle
fill is a boolean indicating whether to fill the rectangle
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
- contains(self, mouseevent)
- get_bbox(self)
- get_height(self)
- Return the height of the rectangle
- get_patch_transform(self)
- get_path(self)
- Return the vertices of the rectangle
- get_width(self)
- Return the width of the rectangle
- get_x(self)
- Return the left coord of the rectangle
- get_y(self)
- Return the bottom coord of the rectangle
- set_bounds(self, *args)
- Set the bounds of the rectangle: l,b,w,h
ACCEPTS: (left, bottom, width, height)
- set_height(self, h)
- Set the width rectangle
ACCEPTS: float
- set_width(self, w)
- Set the width rectangle
ACCEPTS: float
- set_x(self, x)
- Set the left coord of the rectangle
ACCEPTS: float
- set_y(self, y)
- Set the bottom coord of the rectangle
ACCEPTS: float
Methods inherited from Patch:
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class RegularPolygon(Patch) |
| |
A regular polygon patch.
|
| |
- Method resolution order:
- RegularPolygon
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, xy, numVertices, radius=5, orientation=0, **kwargs)
- xy is a length 2 tuple (the center)
numVertices is the number of vertices.
radius is the distance from the center to each of the vertices.
orientation is in radians and rotates the polygon.
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
- get_patch_transform(self)
- get_path(self)
Data descriptors defined here:
- numvertices
- orientation
- radius
- xy
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Shadow(Patch) |
| | |
- Method resolution order:
- Shadow
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, patch, ox, oy, props=None, **kwargs)
- Create a shadow of the patch offset by ox, oy. props, if not None is
a patch property update dictionary. If None, the shadow will have
have the same color as the face, but darkened
kwargs are
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
- get_patch_transform(self)
- get_path(self)
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class Wedge(Patch) |
| | |
- Method resolution order:
- Wedge
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, center, r, theta1, theta2, **kwargs)
- Draw a wedge centered at x,y tuple center with radius r that
sweeps theta1 to theta2 (angles)
Valid kwargs are:
%(Patch)s
- __str__(self)
- get_patch_transform(self)
- get_path(self)
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|
class YAArrow(Patch) |
| |
Yet another arrow class
This is an arrow that is defined in display space and has a tip at
x1,y1 and a base at x2, y2.
|
| |
- Method resolution order:
- YAArrow
- Patch
- matplotlib.artist.Artist
- __builtin__.object
Methods defined here:
- __init__(self, figure, xytip, xybase, width=4, frac=0.10000000000000001, headwidth=12, **kwargs)
- xytip : (x,y) location of arrow tip
xybase : (x,y) location the arrow base mid point
figure : the figure instance (fig.dpi)
width : the width of the arrow in points
frac : the fraction of the arrow length occupied by the head
headwidth : the width of the base of the arrow head in points
Valid kwargs are:
alpha: float
animated: [True | False]
antialiased or aa: [True | False]
clip_box: a matplotlib.transform.Bbox instance
clip_on: [True | False]
edgecolor or ec: any matplotlib color
facecolor or fc: any matplotlib color
figure: a matplotlib.figure.Figure instance
fill: [True | False]
hatch: unknown
label: any string
linewidth or lw: float
lod: [True | False]
transform: a matplotlib.transform transformation instance
visible: [True | False]
zorder: any number
- __str__(self)
- get_patch_transform(self)
- get_path(self)
- getpoints(self, x1, y1, x2, y2, k)
- for line segment defined by x1,y1 and x2,y2, return the points on
the line that is perpendicular to the line and intersects x2,y2
and the distance from x2,y2 ot the returned points is k
Methods inherited from Patch:
- contains(self, mouseevent)
- Test whether the mouse event occurred in the patch.
Returns T/F, {}
- draw(self, renderer)
- get_aa = get_antialiased(self)
- get_antialiased(self)
- get_data_transform(self)
- get_ec = get_edgecolor(self)
- get_edgecolor(self)
- get_extents(self)
- get_facecolor(self)
- get_fc = get_facecolor(self)
- get_fill(self)
- return whether fill is set
- get_hatch(self)
- return the current hatching pattern
- get_linewidth(self)
- get_lw = get_linewidth(self)
- get_transform(self)
- get_window_extent(self, renderer=None)
- set_aa = set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_antialiased(self, aa)
- Set whether to use antialiased rendering
ACCEPTS: [True | False] or None for default
- set_ec = set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_edgecolor(self, color)
- Set the patch edge color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fc = set_facecolor(self, color)
- Set the patch face color
ACCEPTS: mpl color spec, or None for default, or 'none' for no color
- set_fill(self, b)
- Set whether to fill the patch
ACCEPTS: [True | False]
- set_hatch(self, h)
- Set the hatching pattern
hatch can be one of:
/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
# - crossed
x - crossed diagonal
letters can be combined, in which case all the specified
hatchings are done
if same letter repeats, it increases the density of hatching
in that direction
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript
backend only.
2. Hatching is done with solid black lines of width 0.
- set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- set_lw = set_linewidth(self, w)
- Set the patch linewidth in points
ACCEPTS: float or None for default
- update_from(self, other)
Data and other attributes inherited from Patch:
- zorder = 1
Methods inherited from matplotlib.artist.Artist:
- add_callback(self, func)
- 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
- 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_axes(self)
- return the axes instance the artist resides in, or None
- 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_contains(self)
- return the _contains test used by the artist, or None for default.
- get_figure(self)
- return the figure instance
- get_label(self)
- get_picker(self)
- return the Pickeration 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_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 ax.draw_idle().
Call ax.relim() to update the axes limits if desired.
Note: 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 value used for blending - not supported on
all backends
ACCEPTS: float
- set_animated(self, b)
- set the artist's animation state
ACCEPTS: [True | False]
- set_axes(self, axes)
- set the axes instance the artist resides in, if any
ACCEPTS: an axes instance
- 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 Patch (or subclass) instance
b) a Path instance, in which cas aoptional transform 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_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_figure(self, fig)
- Set the figure instance the artist belong to
ACCEPTS: a matplotlib.figure.Figure instance
- set_label(self, s)
- Set the line label to s for auto legend
ACCEPTS: any string
- 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_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_transform(self, t)
- set the Transformation instance used by this artist
ACCEPTS: a matplotlib.transform transformation instance
- 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
- update(self, props)
Data descriptors inherited from matplotlib.artist.Artist:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
| |