| | |
- matplotlib.backend_bases.FigureCanvasBase
-
- FigureCanvasPS
- matplotlib.backend_bases.FigureManagerBase
-
- FigureManagerPS
- FigureManagerPS
- matplotlib.backend_bases.GraphicsContextBase
-
- GraphicsContextPS
- matplotlib.backend_bases.RendererBase
-
- RendererPS
class FigureCanvasPS(matplotlib.backend_bases.FigureCanvasBase) |
| | |
Methods defined here:
- draw(self)
- get_default_filetype(self)
- print_eps(self, outfile, *args, **kwargs)
- print_ps(self, outfile, *args, **kwargs)
Data and other attributes defined here:
- filetypes = {'eps': 'Encapsulated Postscript', 'ps': 'Postscript'}
Methods inherited from matplotlib.backend_bases.FigureCanvasBase:
- __init__(self, figure)
- blit(self, bbox=None)
- blit the canvas in bbox (default entire canvas)
- button_press_event(self, x, y, button, guiEvent=None)
- Backend derived classes should call this function on any mouse
button press. x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
- button_release_event(self, x, y, button, guiEvent=None)
- Backend derived classes should call this function on any mouse
button release. x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
- draw_cursor(self, event)
- Draw a cursor in the event.axes if inaxes is not None. Use
native GUI drawing for efficiency if possible
- draw_event(self, renderer)
- draw_idle(self, *args, **kwargs)
- draw only if idle; defaults to draw but backends can overrride
- get_supported_filetypes(self)
- get_supported_filetypes_grouped(self)
- get_width_height(self)
- return the figure width and height in points or pixels
(depending on the backend), truncated to integers
- key_press_event(self, key, guiEvent=None)
- key_release_event(self, key, guiEvent=None)
- motion_notify_event(self, x, y, guiEvent=None)
- Backend derived classes should call this function on any
motion-notify-event. x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
- mpl_connect(self, s, func)
- Connect event with string s to func. The signature of func is
def func(event)
where event is a MplEvent. The following events are recognized
'resize_event',
'draw_event',
'key_press_event',
'key_release_event',
'button_press_event',
'button_release_event',
'scroll_event',
'motion_notify_event',
'pick_event',
For the three events above, if the mouse is over the axes,
the variable event.inaxes will be set to the axes it is over,
and additionally, the variables event.xdata and event.ydata
will be defined. This is the mouse location in data coords.
See backend_bases.MplEvent.
return value is a connection id that can be used with
mpl_disconnect
- mpl_disconnect(self, cid)
- disconnect callback id cid
- onHilite(self, ev)
- Mouse event processor which highlights the artists
under the cursor. Connect this to the motion_notify_event
using canvas.mpl_connect('motion_notify_event',canvas.onHilite)
- onRemove(self, ev)
- Mouse event processor which removes the top artist
under the cursor. Connect this to the mouse_press_event
using canvas.mpl_connect('mouse_press_event',canvas.onRemove)
- pick(self, mouseevent)
- pick_event(self, mouseevent, artist, **kwargs)
- This method will be called by artists who are picked and will
fire off PickEvent callbacks registered listeners
- print_bmp = print_raw(self, *args, **kwargs)
- print_emf(self, *args, **kwargs)
- print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w', orientation='portrait', format=None, **kwargs)
- Render the figure to hardcopy. Set the figure patch face and edge
colors. This is useful because some of the GUIs have a gray figure
face color background and you'll probably want to override this on
hardcopy.
filename - can also be a file object on image backends
orientation - only currently applies to PostScript printing.
dpi - the dots per inch to save the figure in; if None, use savefig.dpi
facecolor - the facecolor of the figure
edgecolor - the edgecolor of the figure
orientation - 'landscape' | 'portrait' (not supported on all backends)
format - when set, forcibly set the file format to save to
- print_pdf(self, *args, **kwargs)
- print_png(self, *args, **kwargs)
- print_raw(self, *args, **kwargs)
- print_rgb = print_raw(self, *args, **kwargs)
- print_svg(self, *args, **kwargs)
- print_svgz(self, *args, **kwargs)
- resize(self, w, h)
- set the canvas size in pixels
- resize_event(self)
- scroll_event(self, x, y, button, guiEvent=None)
- Backend derived classes should call this function on any
scroll wheel event. x,y are the canvas coords: 0,0 is lower,
left. button and key are as defined in MouseEvent
- set_window_title(self, title)
- Set the title text of the window containing the figure. Note that
this has no effect if there is no window (eg, a PS backend).
- switch_backends(self, FigureCanvasClass)
- instantiate an instance of FigureCanvasClass
This is used for backend switching, eg, to instantiate a
FigureCanvasPS from a FigureCanvasGTK. Note, deep copying is
not done, so any changes to one of the instances (eg, setting
figure size or line props), will be reflected in the other
Data and other attributes inherited from matplotlib.backend_bases.FigureCanvasBase:
- events = ('resize_event', 'draw_event', 'key_press_event', 'key_release_event', 'button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event', 'pick_event')
|
class GraphicsContextPS(matplotlib.backend_bases.GraphicsContextBase) |
| | |
Methods defined here:
- get_capstyle(self)
- get_joinstyle(self)
Methods inherited from matplotlib.backend_bases.GraphicsContextBase:
- __init__(self)
- copy_properties(self, gc)
- Copy properties from gc to self
- get_alpha(self)
- Return the alpha value used for blending - not supported on
all backends
- get_antialiased(self)
- Return true if the object should try to do antialiased rendering
- get_clip_path(self)
- Return the clip path
- get_clip_rectangle(self)
- Return the clip rectangle as (left, bottom, width, height)
- get_dashes(self)
- Return the dash information as an offset dashlist tuple The
dash list is a even size list that gives the ink on, ink off
in pixels. See p107 of to postscript BLUEBOOK for more info
Default value is None
- get_hatch(self)
- Gets the current hatch style
- get_linestyle(self, style)
- Return the linestyle: one of ('solid', 'dashed', 'dashdot',
'dotted').
- get_linewidth(self)
- Return the line width in points as a scalar
- get_rgb(self)
- returns a tuple of three floats from 0-1. color can be a
matlab format string, a html hex color string, or a rgb tuple
- set_alpha(self, alpha)
- Set the alpha value used for blending - not supported on
all backends
- set_antialiased(self, b)
- True if object should be drawn with antialiased rendering
- set_capstyle(self, cs)
- Set the capstyle as a string in ('butt', 'round', 'projecting')
- set_clip_path(self, path)
- Set the clip path
- set_clip_rectangle(self, rectangle)
- Set the clip rectangle with sequence (left, bottom, width, height)
- set_dashes(self, dash_offset, dash_list)
- Set the dash style for the gc.
dash_offset is the offset (usually 0).
dash_list specifies the on-off sequence as points
(None, None) specifies a solid line
- set_foreground(self, fg, isRGB=False)
- Set the foreground color. fg can be a matlab format string, a
html hex color string, an rgb unit tuple, or a float between 0
and 1. In the latter case, grayscale is used.
The GraphicsContext converts colors to rgb internally. If you
know the color is rgb already, you can set isRGB to True to
avoid the performace hit of the conversion
- set_graylevel(self, frac)
- Set the foreground color to be a gray level with frac frac
- set_hatch(self, hatch)
- Sets the hatch style for filling
- set_joinstyle(self, js)
- Set the join style to be one of ('miter', 'round', 'bevel')
- set_linestyle(self, style)
- Set the linestyle to be one of ('solid', 'dashed', 'dashdot',
'dotted').
- set_linewidth(self, w)
- Set the linewidth in points
Data and other attributes inherited from matplotlib.backend_bases.GraphicsContextBase:
- dashd = {'dashdot': (0, (3.0, 5.0, 1.0, 5.0)), 'dashed': (0, (6.0, 6.0)), 'dotted': (0, (1.0, 3.0)), 'solid': (None, None)}
|
class RendererPS(matplotlib.backend_bases.RendererBase) |
| |
The renderer handles all the drawing primitives using a graphics
context instance that controls the colors/styles.
|
| |
Methods defined here:
- __init__(self, width, height, pswriter, dpi=72)
- draw_arc(self, gc, rgbFace, x, y, width, height, angle1, angle2, rotation)
- Draw an arc centered at x,y with width and height and angles
from 0.0 to 360.0
If gcFace is not None, fill the arc slice with it. gcEdge
is a GraphicsContext instance
- draw_image(self, x, y, im, bbox)
- Draw the Image instance into the current axes; x is the
distance in pixels from the left hand side of the canvas and y
is the distance from bottom
bbox is a matplotlib.transforms.BBox instance for clipping, or
None
- draw_line(self, gc, x0, y0, x1, y1)
- Draw a single line from x0,y0 to x1,y1
- draw_lines(self, gc, x, y, transform)
- x and y are npy.equal length arrays, draw lines connecting each
point in x, y
- draw_lines_old(self, gc, x, y, transform=None)
- x and y are npy.equal length arrays, draw lines connecting each
point in x, y
- draw_markers(self, gc, path, rgbFace, x, y, transform)
- Draw the markers defined by path at each of the positions in x
and y. path coordinates are points, x and y coords will be
transformed by the transform
- draw_mathtext(self, gc, x, y, s, prop, angle)
- Draw the math text using matplotlib.mathtext
- draw_path(self, gc, rgbFace, path)
- draw_point(self, gc, x, y)
- Draw a single point at x,y
- draw_polygon(self, gc, rgbFace, points)
- Draw a polygon. points is a len vertices tuple, each element
giving the x,y coords a vertex
If rgbFace is not None, fill the poly with it. gc
is a GraphicsContext instance
- draw_rectangle(self, gc, rgbFace, x, y, width, height)
- Draw a rectangle with lower left at x,y with width and height.
If gcFace is not None, fill the rectangle with it. gcEdge
is a GraphicsContext instance
- draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!')
- draw a Text instance
- draw_text(self, gc, x, y, s, prop, angle, ismath)
- draw a Text instance
- draw_unicode(self, gc, x, y, s, prop, angle)
- draw a unicode string. ps doesn't have unicode support, so
we have to do this the hard way
- flipy(self)
- return true if small y numbers are top for renderer
- get_canvas_width_height(self)
- return the canvas width and height in display coords
- get_image_magnification(self)
- Get the factor by which to magnify images passed to draw_image.
Allows a backend to have images at a different resolution to other
artists.
- get_text_width_height_descent(self, s, prop, ismath)
- get the width and height in display coords of the string s
with FontPropertry prop
- merge_used_characters(self, other)
- new_gc(self)
- push_gc(self, gc, store=1)
- Push the current onto stack, with the exception of the clip box, which
must be isolated in a gsave/grestore pair.
- set_color(self, r, g, b, store=1)
- set_font(self, fontname, fontsize, store=1)
- set_hatch(self, hatch)
- 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
- set_linecap(self, linecap, store=1)
- set_linedash(self, offset, seq, store=1)
- set_linejoin(self, linejoin, store=1)
- set_linewidth(self, linewidth, store=1)
- track_characters(self, font, s)
- Keeps track of which characters are required from
each font.
Methods inherited from matplotlib.backend_bases.RendererBase:
- close_group(self, s)
- close a grouping element with label s
Is only currently used by backend_svg
- draw_line_collection(self, segments, transform, clipbox, colors, linewidths, linestyle, antialiaseds, offsets, transOffset)
- This is a function for optimized line drawing. If you need to draw
many line segments with similar properties, it is faster to avoid the
overhead of all the object creation etc. The lack of total
configurability is compensated for with efficiency. Hence we don't use
a GC and many of the line props it supports. See
matplotlib.collections for more details.
segments is a sequence of ( line0, line1, line2), where linen =
is an Mx2 array with columns x, y. Each line can be a
different length
transform is used to Transform the lines
clipbox is a xmin, ymin, width, height clip rect
colors is a tuple of RGBA tuples
linewidths is a tuple of linewidths
*** really should be called 'dashes' not 'linestyle', since
we call gc.set_dashes() not gc.set_linestyle() ***
linestyle is an (offset, onoffseq) tuple or None,None for solid
antialiseds is a tuple of ones or zeros indicating whether the
segment should be aa or not
offsets, if not None, is an Nx2 array of x,y offsets to
translate the lines by after transform is used to transform
the offset coords
This function could be overridden in the backend to possibly implement
faster drawing, but it is already much faster than using draw_lines()
by itself.
- draw_poly_collection(self, verts, transform, clipbox, facecolors, edgecolors, linewidths, antialiaseds, offsets, transOffset)
- Draw a polygon collection
verts are a sequence of polygon vectors, where each polygon
vector is a sequence of x,y tuples of vertices
facecolors and edgecolors are a sequence of RGBA tuples
linewidths are a sequence of linewidths
antialiaseds are a sequence of 0,1 integers whether to use aa
If a linewidth is zero or an edgecolor alpha is zero, the
line will be omitted; similarly, the fill will be omitted
if the facecolor alpha is zero.
- draw_quad_mesh(self, meshWidth, meshHeight, colors, xCoords, yCoords, clipbox, transform, offsets, transOffset, showedges)
- Draw a quadrilateral mesh
See documentation in QuadMesh class in collections.py for details
- draw_regpoly_collection(self, clipbox, offsets, transOffset, verts, sizes, facecolors, edgecolors, linewidths, antialiaseds)
- Draw a regular poly collection
offsets - is a sequence is x,y tuples
transOffset - maps this to display coords
verts - are the vertices of the regular polygon at the origin
sizes are the area of the circle that circumscribes the
polygon in points^2
facecolors and edgecolors are a sequence of RGBA tuples
linewidths are a sequence of linewidths
antialiaseds are a sequence of 0,1 integers whether to use aa
- get_texmanager(self)
- get_text_extent(self, text)
- Get the text extent in window coords
- open_group(self, s)
- open a grouping element with label s
Is only currently used by backend_svg
- option_image_nocomposite(self)
- overwrite this method for renderers that do not necessarily
want to rescale and composite raster images. (like SVG)
- points_to_pixels(self, points)
- Convert points to display units
points - a float or a numpy array of float
return points converted to pixels
You need to override this function (unless your backend doesn't have a
dpi, eg, postscript or svg).
Some imaging systems assume some value for pixels per inch.
points to pixels = points * pixels_per_inch/72.0 * dpi/72.0
- strip_math(self, s)
| |