doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
get_capstyle()[source]
Return the CapStyle. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_capstyle |
get_clip_path()[source]
Return the clip path in the form (path, transform), where path is a Path instance, and transform is an affine transform to apply to the path before clipping. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_clip_path |
get_clip_rectangle()[source]
Return the clip rectangle as a Bbox instance. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_clip_rectangle |
get_dashes()[source]
Return the dash style as an (offset, dash-list) pair. The dash list is a even-length list that gives the ink on, ink off in points. See p. 107 of to PostScript blue book for more info. Default value is (None, None). | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_dashes |
get_forced_alpha()[source]
Return whether the value given by get_alpha() should be used to override any other alpha-channel values. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_forced_alpha |
get_gid()[source]
Return the object identifier if one is set, None otherwise. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_gid |
get_hatch()[source]
Get the current hatch style. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_hatch |
get_hatch_color()[source]
Get the hatch color. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_hatch_color |
get_hatch_linewidth()[source]
Get the hatch linewidth. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_hatch_linewidth |
get_hatch_path(density=6.0)[source]
Return a Path for the current hatch. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_hatch_path |
get_joinstyle()[source]
Return the JoinStyle. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_joinstyle |
get_linewidth()[source]
Return the line width in points. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_linewidth |
get_rgb()[source]
Return a tuple of three or four floats from 0-1. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_rgb |
get_sketch_params()[source]
Return the sketch parameters for the artist. Returns
tuple or None
A 3-tuple with the following elements:
scale: The amplitude of the wiggle perpendicular to the source line.
length: The length of the wiggle along the line.
randomness: The scale factor by which the length is shrunken or expanded. May return None if no sketch parameters were set. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_sketch_params |
get_snap()[source]
Return the snap setting, which can be: True: snap vertices to the nearest pixel center False: leave vertices as-is None: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_snap |
get_url()[source]
Return a url if one is set, None otherwise. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.get_url |
restore()[source]
Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.restore |
set_alpha(alpha)[source]
Set the alpha value used for blending - not supported on all backends. If alpha=None (the default), the alpha components of the foreground and fill colors will be used to set their respective transparencies (where applicable); otherwise, alpha will override them. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_alpha |
set_antialiased(b)[source]
Set whether object should be drawn with antialiased rendering. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_antialiased |
set_capstyle(cs)[source]
Set how to draw endpoints of lines. Parameters
csCapStyle or {'butt', 'projecting', 'round'} | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_capstyle |
set_clip_path(path)[source]
Set the clip path to a TransformedPath or None. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_clip_path |
set_clip_rectangle(rectangle)[source]
Set the clip rectangle to a Bbox or None. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_clip_rectangle |
set_dashes(dash_offset, dash_list)[source]
Set the dash style for the gc. Parameters
dash_offsetfloat
The offset (usually 0).
dash_listarray-like or None
The on-off sequence as points. None specifies a solid line. Notes See p. 107 of to PostScript blue book for more info. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_dashes |
set_foreground(fg, isRGBA=False)[source]
Set the foreground color. Parameters
fgcolor
isRGBAbool
If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_foreground |
set_gid(id)[source]
Set the id. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_gid |
set_hatch(hatch)[source]
Set the hatch style (for fills). | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_hatch |
set_hatch_color(hatch_color)[source]
Set the hatch color. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_hatch_color |
set_joinstyle(js)[source]
Set how to draw connections between line segments. Parameters
jsJoinStyle or {'miter', 'round', 'bevel'} | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_joinstyle |
set_linewidth(w)[source]
Set the linewidth in points. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_linewidth |
set_sketch_params(scale=None, length=None, randomness=None)[source]
Set the sketch parameters. Parameters
scalefloat, optional
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
lengthfloat, default: 128
The length of the wiggle along the line, in pixels.
randomnessfloat, default: 16
The scale factor by which the length is shrunken or expanded. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_sketch_params |
set_snap(snap)[source]
Set the snap setting which may be: True: snap vertices to the nearest pixel center False: leave vertices as-is None: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_snap |
set_url(url)[source]
Set the url for links in compatible backends. | matplotlib.backend_bases_api#matplotlib.backend_bases.GraphicsContextBase.set_url |
matplotlib.backend_bases.key_press_handler(event, canvas=None, toolbar=None)[source]
Implement the default Matplotlib key bindings for the canvas and toolbar described at Navigation keyboard shortcuts. Parameters
eventKeyEvent
A key press/release event.
canvasFigureCanvasBase, default: event.canvas
The backend-specific canvas instance. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.
toolbarNavigationToolbar2, default: event.canvas.toolbar
The navigation cursor toolbar. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.toolbar. | matplotlib.backend_bases_api#matplotlib.backend_bases.key_press_handler |
classmatplotlib.backend_bases.KeyEvent(name, canvas, key, x=0, y=0, guiEvent=None)[source]
Bases: matplotlib.backend_bases.LocationEvent A key event (key press, key release). A KeyEvent has a number of special attributes in addition to those defined by the parent Event and LocationEvent classes. Notes Modifier keys will be prefixed to the pressed key and will be in the order "ctrl", "alt", "super". The exception to this rule is when the pressed key is itself a modifier key, therefore "ctrl+alt" and "alt+control" can both be valid key values. Examples def on_key(event):
print('you pressed', event.key, event.xdata, event.ydata)
cid = fig.canvas.mpl_connect('key_press_event', on_key)
Attributes
keyNone or str
The key(s) pressed. Could be None, a single case sensitive Unicode character ("g", "G", "#", etc.), a special key ("control", "shift", "f1", "up", etc.) or a combination of the above (e.g., "ctrl+alt+g", "ctrl+alt+G"). | matplotlib.backend_bases_api#matplotlib.backend_bases.KeyEvent |
classmatplotlib.backend_bases.LocationEvent(name, canvas, x, y, guiEvent=None)[source]
Bases: matplotlib.backend_bases.Event An event that has a screen location. A LocationEvent has a number of special attributes in addition to those defined by the parent Event class. Attributes
x, yint or None
Event location in pixels from bottom left of canvas.
inaxesAxes or None
The Axes instance over which the mouse is, if any.
xdata, ydatafloat or None
Data coordinates of the mouse within inaxes, or None if the mouse is not over an Axes. lastevent=None | matplotlib.backend_bases_api#matplotlib.backend_bases.LocationEvent |
lastevent=None | matplotlib.backend_bases_api#matplotlib.backend_bases.LocationEvent.lastevent |
classmatplotlib.backend_bases.MouseButton(value)[source]
Bases: enum.IntEnum An enumeration. BACK=8[source]
FORWARD=9[source]
LEFT=1[source]
MIDDLE=2[source]
RIGHT=3[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseButton |
BACK=8[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseButton.BACK |
FORWARD=9[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseButton.FORWARD |
LEFT=1[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseButton.LEFT |
MIDDLE=2[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseButton.MIDDLE |
RIGHT=3[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseButton.RIGHT |
classmatplotlib.backend_bases.MouseEvent(name, canvas, x, y, button=None, key=None, step=0, dblclick=False, guiEvent=None)[source]
Bases: matplotlib.backend_bases.LocationEvent A mouse event ('button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event'). A MouseEvent has a number of special attributes in addition to those defined by the parent Event and LocationEvent classes. Examples def on_press(event):
print('you pressed', event.button, event.xdata, event.ydata)
cid = fig.canvas.mpl_connect('button_press_event', on_press)
Attributes
buttonNone or MouseButton or {'up', 'down'}
The button pressed. 'up' and 'down' are used for scroll events. Note that LEFT and RIGHT actually refer to the "primary" and "secondary" buttons, i.e. if the user inverts their left and right buttons ("left-handed setting") then the LEFT button will be the one physically on the right.
keyNone or str
The key pressed when the mouse event triggered, e.g. 'shift'. See KeyEvent. Warning This key is currently obtained from the last 'key_press_event' or 'key_release_event' that occurred within the canvas. Thus, if the last change of keyboard state occurred while the canvas did not have focus, this attribute will be wrong.
stepfloat
The number of scroll steps (positive for 'up', negative for 'down'). This applies only to 'scroll_event' and defaults to 0 otherwise.
dblclickbool
Whether the event is a double-click. This applies only to 'button_press_event' and is False otherwise. In particular, it's not used in 'button_release_event'. | matplotlib.backend_bases_api#matplotlib.backend_bases.MouseEvent |
classmatplotlib.backend_bases.NavigationToolbar2(canvas)[source]
Bases: object Base class for the navigation cursor, version 2. Backends must implement a canvas that handles connections for 'button_press_event' and 'button_release_event'. See FigureCanvasBase.mpl_connect() for more information. They must also define save_figure()
save the current figure
draw_rubberband() (optional)
draw the zoom to rect "rubberband" rectangle
set_message() (optional)
display message
set_history_buttons() (optional)
you can change the history back / forward buttons to indicate disabled / enabled state. and override __init__ to set up the toolbar -- without forgetting to call the base-class init. Typically, __init__ needs to set up toolbar buttons connected to the home, back, forward, pan, zoom, and save_figure methods and using standard icons in the "images" subdirectory of the data path. That's it, we'll do the rest! back(*args)[source]
Move back up the view lim stack. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them.
configure_subplots(*args)[source]
drag_pan(event)[source]
Callback for dragging in pan/zoom mode.
drag_zoom(event)[source]
Callback for dragging in zoom mode.
draw_rubberband(event, x0, y0, x1, y1)[source]
Draw a rectangle rubberband to indicate zoom limits. Note that it is not guaranteed that x0 <= x1 and y0 <= y1.
forward(*args)[source]
Move forward in the view lim stack. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them.
home(*args)[source]
Restore the original view. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them.
mouse_move(event)[source]
pan(*args)[source]
Toggle the pan/zoom tool. Pan with left button, zoom with right.
press_pan(event)[source]
Callback for mouse button press in pan/zoom mode.
press_zoom(event)[source]
Callback for mouse button press in zoom to rect mode.
push_current()[source]
Push the current view limits and position onto the stack.
release_pan(event)[source]
Callback for mouse button release in pan/zoom mode.
release_zoom(event)[source]
Callback for mouse button release in zoom to rect mode.
remove_rubberband()[source]
Remove the rubberband.
save_figure(*args)[source]
Save the current figure.
set_cursor(cursor)[source]
[Deprecated] Set the current cursor to one of the Cursors enums values. If required by the backend, this method should trigger an update in the backend event loop after the cursor is set, as this method may be called e.g. before a long-running task during which the GUI is not updated. Notes Deprecated since version 3.5.
set_history_buttons()[source]
Enable or disable the back/forward button.
set_message(s)[source]
Display a message on toolbar or in status bar.
toolitems=(('Home', 'Reset original view', 'home', 'home'), ('Back', 'Back to previous view', 'back', 'back'), ('Forward', 'Forward to next view', 'forward', 'forward'), (None, None, None, None), ('Pan', 'Left button pans, Right button zooms\nx/y fixes axis, CTRL fixes aspect', 'move', 'pan'), ('Zoom', 'Zoom to rectangle\nx/y fixes axis', 'zoom_to_rect', 'zoom'), ('Subplots', 'Configure subplots', 'subplots', 'configure_subplots'), (None, None, None, None), ('Save', 'Save the figure', 'filesave', 'save_figure'))
update()[source]
Reset the axes stack.
zoom(*args)[source]
Toggle zoom to rect mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2 |
back(*args)[source]
Move back up the view lim stack. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.back |
configure_subplots(*args)[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.configure_subplots |
drag_pan(event)[source]
Callback for dragging in pan/zoom mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.drag_pan |
drag_zoom(event)[source]
Callback for dragging in zoom mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.drag_zoom |
draw_rubberband(event, x0, y0, x1, y1)[source]
Draw a rectangle rubberband to indicate zoom limits. Note that it is not guaranteed that x0 <= x1 and y0 <= y1. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.draw_rubberband |
forward(*args)[source]
Move forward in the view lim stack. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.forward |
home(*args)[source]
Restore the original view. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.home |
mouse_move(event)[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.mouse_move |
pan(*args)[source]
Toggle the pan/zoom tool. Pan with left button, zoom with right. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.pan |
press_pan(event)[source]
Callback for mouse button press in pan/zoom mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.press_pan |
press_zoom(event)[source]
Callback for mouse button press in zoom to rect mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.press_zoom |
push_current()[source]
Push the current view limits and position onto the stack. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.push_current |
release_pan(event)[source]
Callback for mouse button release in pan/zoom mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.release_pan |
release_zoom(event)[source]
Callback for mouse button release in zoom to rect mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.release_zoom |
remove_rubberband()[source]
Remove the rubberband. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.remove_rubberband |
save_figure(*args)[source]
Save the current figure. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.save_figure |
set_cursor(cursor)[source]
[Deprecated] Set the current cursor to one of the Cursors enums values. If required by the backend, this method should trigger an update in the backend event loop after the cursor is set, as this method may be called e.g. before a long-running task during which the GUI is not updated. Notes Deprecated since version 3.5. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.set_cursor |
set_history_buttons()[source]
Enable or disable the back/forward button. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.set_history_buttons |
set_message(s)[source]
Display a message on toolbar or in status bar. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.set_message |
toolitems=(('Home', 'Reset original view', 'home', 'home'), ('Back', 'Back to previous view', 'back', 'back'), ('Forward', 'Forward to next view', 'forward', 'forward'), (None, None, None, None), ('Pan', 'Left button pans, Right button zooms\nx/y fixes axis, CTRL fixes aspect', 'move', 'pan'), ('Zoom', 'Zoom to rectangle\nx/y fixes axis', 'zoom_to_rect', 'zoom'), ('Subplots', 'Configure subplots', 'subplots', 'configure_subplots'), (None, None, None, None), ('Save', 'Save the figure', 'filesave', 'save_figure')) | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.toolitems |
update()[source]
Reset the axes stack. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.update |
zoom(*args)[source]
Toggle zoom to rect mode. | matplotlib.backend_bases_api#matplotlib.backend_bases.NavigationToolbar2.zoom |
exceptionmatplotlib.backend_bases.NonGuiException[source]
Bases: Exception Raised when trying show a figure in a non-GUI backend. | matplotlib.backend_bases_api#matplotlib.backend_bases.NonGuiException |
classmatplotlib.backend_bases.PickEvent(name, canvas, mouseevent, artist, guiEvent=None, **kwargs)[source]
Bases: matplotlib.backend_bases.Event A pick event. This event is fired when the user picks a location on the canvas sufficiently close to an artist that has been made pickable with Artist.set_picker. A PickEvent has a number of special attributes in addition to those defined by the parent Event class. Examples Bind a function on_pick() to pick events, that prints the coordinates of the picked data point: ax.plot(np.rand(100), 'o', picker=5) # 5 points tolerance
def on_pick(event):
line = event.artist
xdata, ydata = line.get_data()
ind = event.ind
print('on pick line:', np.array([xdata[ind], ydata[ind]]).T)
cid = fig.canvas.mpl_connect('pick_event', on_pick)
Attributes
mouseeventMouseEvent
The mouse event that generated the pick.
artistmatplotlib.artist.Artist
The picked artist. Note that artists are not pickable by default (see Artist.set_picker). other
Additional attributes may be present depending on the type of the picked object; e.g., a Line2D pick may define different extra attributes than a PatchCollection pick. | matplotlib.backend_bases_api#matplotlib.backend_bases.PickEvent |
matplotlib.backend_bases.register_backend(format, backend, description=None)[source]
Register a backend for saving to a given file format. Parameters
formatstr
File extension
backendmodule string or canvas class
Backend for handling file output
descriptionstr, default: ""
Description of the file type. | matplotlib.backend_bases_api#matplotlib.backend_bases.register_backend |
classmatplotlib.backend_bases.RendererBase[source]
Bases: object An abstract base class to handle drawing/rendering operations. The following methods must be implemented in the backend for full functionality (though just implementing draw_path() alone would give a highly capable backend): draw_path() draw_image() draw_gouraud_triangle() The following methods should be implemented in the backend for optimization reasons: draw_text() draw_markers() draw_path_collection() draw_quad_mesh() close_group(s)[source]
Close a grouping element with label s. Only used by the SVG renderer.
draw_gouraud_triangle(gc, points, colors, transform)[source]
Draw a Gouraud-shaded triangle. Parameters
gcGraphicsContextBase
The graphics context.
points(3, 2) array-like
Array of (x, y) points for the triangle.
colors(3, 4) array-like
RGBA colors for each point of the triangle.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points.
draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]
Draw a series of Gouraud triangles. Parameters
points(N, 3, 2) array-like
Array of N (x, y) points for the triangles.
colors(N, 3, 4) array-like
Array of N RGBA colors for each point of the triangles.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points.
draw_image(gc, x, y, im, transform=None)[source]
Draw an RGBA image. Parameters
gcGraphicsContextBase
A graphics context with clipping information.
xscalar
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
yscalar
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
im(N, M, 4) array-like of np.uint8
An array of RGBA pixels.
transformmatplotlib.transforms.Affine2DBase
If and only if the concrete backend is written such that option_scale_image() returns True, an affine transformation (i.e., an Affine2DBase) may be passed to draw_image(). The translation vector of the transformation is given in physical units (i.e., dots or pixels). Note that the transformation does not override x and y, and has to be applied before translating the result by x and y (this can be accomplished by adding x and y to the translation vector defined by transform).
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). This provides a fallback implementation of draw_markers that makes multiple calls to draw_path(). Some backends may want to override this method in order to draw the marker only once and reuse it multiple times. Parameters
gcGraphicsContextBase
The graphics context.
marker_transmatplotlib.transforms.Transform
An affine transform applied to the marker.
transmatplotlib.transforms.Transform
An affine transform applied to the path.
draw_path(gc, path, transform, rgbFace=None)[source]
Draw a Path instance using the given affine transform.
draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]
Draw a collection of paths selecting drawing properties from the lists facecolors, edgecolors, linewidths, linestyles and antialiaseds. offsets is a list of offsets to apply to each of the paths. The offsets in offsets are first transformed by offsetTrans before being applied. offset_position is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_path(). Some backends may want to override this in order to render each set of path data only once, and then reference that path multiple times with the different offsets, colors, styles etc. The generator methods _iter_collection_raw_paths() and _iter_collection() are provided to help with (and standardize) the implementation across backends. It is highly recommended to use those generators, so that changes to the behavior of draw_path_collection() can be made globally.
draw_quad_mesh(gc, master_transform, meshWidth, meshHeight, coordinates, offsets, offsetTrans, facecolors, antialiased, edgecolors)[source]
Fallback implementation of draw_quad_mesh() that generates paths and then calls draw_path_collection().
draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
Draw the text instance. Parameters
gcGraphicsContextBase
The graphics context.
xfloat
The x location of the text in display coords.
yfloat
The y location of the text baseline in display coords.
sstr
The text string.
propmatplotlib.font_manager.FontProperties
The font properties.
anglefloat
The rotation angle in degrees anti-clockwise.
mtextmatplotlib.text.Text
The original text object to be rendered. Notes Note for backend implementers: When you are trying to determine if you have gotten your bounding box right (which is what enables the text layout/alignment to work properly), it helps to change the line in text.py: if 0: bbox_artist(self, renderer)
to if 1, and then the actual bounding box will be plotted along with your text.
flipy()[source]
Return whether y values increase from top to bottom. Note that this only affects drawing of texts and images.
get_canvas_width_height()[source]
Return the canvas width and height in display coords.
get_image_magnification()[source]
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_texmanager()[source]
Return the TexManager instance.
get_text_width_height_descent(s, prop, ismath)[source]
Get the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop.
new_gc()[source]
Return an instance of a GraphicsContextBase.
open_group(s, gid=None)[source]
Open a grouping element with label s and gid (if set) as id. Only used by the SVG renderer.
option_image_nocomposite()[source]
Return whether image composition by Matplotlib should be skipped. Raster backends should usually return False (letting the C-level rasterizer take care of image composition); vector backends should usually return not rcParams["image.composite_image"].
option_scale_image()[source]
Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends).
points_to_pixels(points)[source]
Convert points to display units. You need to override this function (unless your backend doesn't have a dpi, e.g., postscript or svg). Some imaging systems assume some value for pixels per inch: points to pixels = points * pixels_per_inch/72 * dpi/72
Parameters
pointsfloat or array-like
a float or a numpy array of float Returns
Points converted to pixels
start_filter()[source]
Switch to a temporary renderer for image filtering effects. Currently only supported by the agg renderer.
start_rasterizing()[source]
Switch to the raster renderer. Used by MixedModeRenderer.
stop_filter(filter_func)[source]
Switch back to the original renderer. The contents of the temporary renderer is processed with the filter_func and is drawn on the original renderer as an image. Currently only supported by the agg renderer.
stop_rasterizing()[source]
Switch back to the vector renderer and draw the contents of the raster renderer as an image on the vector renderer. Used by MixedModeRenderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase |
close_group(s)[source]
Close a grouping element with label s. Only used by the SVG renderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.close_group |
draw_gouraud_triangle(gc, points, colors, transform)[source]
Draw a Gouraud-shaded triangle. Parameters
gcGraphicsContextBase
The graphics context.
points(3, 2) array-like
Array of (x, y) points for the triangle.
colors(3, 4) array-like
RGBA colors for each point of the triangle.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_gouraud_triangle |
draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]
Draw a series of Gouraud triangles. Parameters
points(N, 3, 2) array-like
Array of N (x, y) points for the triangles.
colors(N, 3, 4) array-like
Array of N RGBA colors for each point of the triangles.
transformmatplotlib.transforms.Transform
An affine transform to apply to the points. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_gouraud_triangles |
draw_image(gc, x, y, im, transform=None)[source]
Draw an RGBA image. Parameters
gcGraphicsContextBase
A graphics context with clipping information.
xscalar
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
yscalar
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
im(N, M, 4) array-like of np.uint8
An array of RGBA pixels.
transformmatplotlib.transforms.Affine2DBase
If and only if the concrete backend is written such that option_scale_image() returns True, an affine transformation (i.e., an Affine2DBase) may be passed to draw_image(). The translation vector of the transformation is given in physical units (i.e., dots or pixels). Note that the transformation does not override x and y, and has to be applied before translating the result by x and y (this can be accomplished by adding x and y to the translation vector defined by transform). | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_image |
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]
Draw a marker at each of path's vertices (excluding control points). This provides a fallback implementation of draw_markers that makes multiple calls to draw_path(). Some backends may want to override this method in order to draw the marker only once and reuse it multiple times. Parameters
gcGraphicsContextBase
The graphics context.
marker_transmatplotlib.transforms.Transform
An affine transform applied to the marker.
transmatplotlib.transforms.Transform
An affine transform applied to the path. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_markers |
draw_path(gc, path, transform, rgbFace=None)[source]
Draw a Path instance using the given affine transform. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_path |
draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]
Draw a collection of paths selecting drawing properties from the lists facecolors, edgecolors, linewidths, linestyles and antialiaseds. offsets is a list of offsets to apply to each of the paths. The offsets in offsets are first transformed by offsetTrans before being applied. offset_position is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_path(). Some backends may want to override this in order to render each set of path data only once, and then reference that path multiple times with the different offsets, colors, styles etc. The generator methods _iter_collection_raw_paths() and _iter_collection() are provided to help with (and standardize) the implementation across backends. It is highly recommended to use those generators, so that changes to the behavior of draw_path_collection() can be made globally. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_path_collection |
draw_quad_mesh(gc, master_transform, meshWidth, meshHeight, coordinates, offsets, offsetTrans, facecolors, antialiased, edgecolors)[source]
Fallback implementation of draw_quad_mesh() that generates paths and then calls draw_path_collection(). | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_quad_mesh |
draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source] | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_tex |
draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]
Draw the text instance. Parameters
gcGraphicsContextBase
The graphics context.
xfloat
The x location of the text in display coords.
yfloat
The y location of the text baseline in display coords.
sstr
The text string.
propmatplotlib.font_manager.FontProperties
The font properties.
anglefloat
The rotation angle in degrees anti-clockwise.
mtextmatplotlib.text.Text
The original text object to be rendered. Notes Note for backend implementers: When you are trying to determine if you have gotten your bounding box right (which is what enables the text layout/alignment to work properly), it helps to change the line in text.py: if 0: bbox_artist(self, renderer)
to if 1, and then the actual bounding box will be plotted along with your text. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.draw_text |
flipy()[source]
Return whether y values increase from top to bottom. Note that this only affects drawing of texts and images. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.flipy |
get_canvas_width_height()[source]
Return the canvas width and height in display coords. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.get_canvas_width_height |
get_image_magnification()[source]
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. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.get_image_magnification |
get_texmanager()[source]
Return the TexManager instance. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.get_texmanager |
get_text_width_height_descent(s, prop, ismath)[source]
Get the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.get_text_width_height_descent |
new_gc()[source]
Return an instance of a GraphicsContextBase. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.new_gc |
open_group(s, gid=None)[source]
Open a grouping element with label s and gid (if set) as id. Only used by the SVG renderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.open_group |
option_image_nocomposite()[source]
Return whether image composition by Matplotlib should be skipped. Raster backends should usually return False (letting the C-level rasterizer take care of image composition); vector backends should usually return not rcParams["image.composite_image"]. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.option_image_nocomposite |
option_scale_image()[source]
Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends). | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.option_scale_image |
points_to_pixels(points)[source]
Convert points to display units. You need to override this function (unless your backend doesn't have a dpi, e.g., postscript or svg). Some imaging systems assume some value for pixels per inch: points to pixels = points * pixels_per_inch/72 * dpi/72
Parameters
pointsfloat or array-like
a float or a numpy array of float Returns
Points converted to pixels | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.points_to_pixels |
start_filter()[source]
Switch to a temporary renderer for image filtering effects. Currently only supported by the agg renderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.start_filter |
start_rasterizing()[source]
Switch to the raster renderer. Used by MixedModeRenderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.start_rasterizing |
stop_filter(filter_func)[source]
Switch back to the original renderer. The contents of the temporary renderer is processed with the filter_func and is drawn on the original renderer as an image. Currently only supported by the agg renderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.stop_filter |
stop_rasterizing()[source]
Switch back to the vector renderer and draw the contents of the raster renderer as an image on the vector renderer. Used by MixedModeRenderer. | matplotlib.backend_bases_api#matplotlib.backend_bases.RendererBase.stop_rasterizing |
classmatplotlib.backend_bases.ResizeEvent(name, canvas)[source]
Bases: matplotlib.backend_bases.Event An event triggered by a canvas resize. A ResizeEvent has a number of special attributes in addition to those defined by the parent Event class. Attributes
widthint
Width of the canvas in pixels.
heightint
Height of the canvas in pixels. | matplotlib.backend_bases_api#matplotlib.backend_bases.ResizeEvent |
classmatplotlib.backend_bases.ShowBase[source]
Bases: matplotlib.backend_bases._Backend Simple base class to generate a show() function in backends. Subclass must override mainloop() method. | matplotlib.backend_bases_api#matplotlib.backend_bases.ShowBase |
classmatplotlib.backend_bases.TimerBase(interval=None, callbacks=None)[source]
Bases: object A base class for providing timer events, useful for things animations. Backends need to implement a few specific methods in order to use their own timing mechanisms so that the timer events are integrated into their event loops. Subclasses must override the following methods:
_timer_start: Backend-specific code for starting the timer.
_timer_stop: Backend-specific code for stopping the timer. Subclasses may additionally override the following methods:
_timer_set_single_shot: Code for setting the timer to single shot operating mode, if supported by the timer object. If not, the Timer class itself will store the flag and the _on_timer method should be overridden to support such behavior.
_timer_set_interval: Code for setting the interval on the timer, if there is a method for doing so on the timer object.
_on_timer: The internal function that any timer object should call, which will handle the task of running all callbacks that have been set. Parameters
intervalint, default: 1000ms
The time between timer events in milliseconds. Will be stored as timer.interval.
callbackslist[tuple[callable, tuple, dict]]
List of (func, args, kwargs) tuples that will be called upon timer events. This list is accessible as timer.callbacks and can be manipulated directly, or the functions add_callback and remove_callback can be used. add_callback(func, *args, **kwargs)[source]
Register func to be called by timer when the event fires. Any additional arguments provided will be passed to func. This function returns func, which makes it possible to use it as a decorator.
propertyinterval
The time between timer events, in milliseconds.
remove_callback(func, *args, **kwargs)[source]
Remove func from list of callbacks. args and kwargs are optional and used to distinguish between copies of the same function registered to be called with different arguments. This behavior is deprecated. In the future, *args, **kwargs won't be considered anymore; to keep a specific callback removable by itself, pass it to add_callback as a functools.partial object.
propertysingle_shot
Whether this timer should stop after a single run.
start(interval=None)[source]
Start the timer object. Parameters
intervalint, optional
Timer interval in milliseconds; overrides a previously set interval if provided.
stop()[source]
Stop the timer. | matplotlib.backend_bases_api#matplotlib.backend_bases.TimerBase |
add_callback(func, *args, **kwargs)[source]
Register func to be called by timer when the event fires. Any additional arguments provided will be passed to func. This function returns func, which makes it possible to use it as a decorator. | matplotlib.backend_bases_api#matplotlib.backend_bases.TimerBase.add_callback |
remove_callback(func, *args, **kwargs)[source]
Remove func from list of callbacks. args and kwargs are optional and used to distinguish between copies of the same function registered to be called with different arguments. This behavior is deprecated. In the future, *args, **kwargs won't be considered anymore; to keep a specific callback removable by itself, pass it to add_callback as a functools.partial object. | matplotlib.backend_bases_api#matplotlib.backend_bases.TimerBase.remove_callback |
start(interval=None)[source]
Start the timer object. Parameters
intervalint, optional
Timer interval in milliseconds; overrides a previously set interval if provided. | matplotlib.backend_bases_api#matplotlib.backend_bases.TimerBase.start |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.