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 shrun... | 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 o... | 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 back... | 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 w... | 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 i... | 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 att... | 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 ... | 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... | 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 rectang... | 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 PickEven... | 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() dr... | 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.t... | 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.transfor... | 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 p... | 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 mark... | 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. o... | 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.
propmatplotl... | 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 arr... | 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
H... | 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 loo... | 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... | 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.