Abstract base classes define the primitives that renderers and graphics contexts must implement to serve as a Matplotlib backend.
An abstract base class to handle drawing/rendering operations.
The abstraction layer that separates the Figure from the backend specific details like a user interface drawing area.
An abstract base class that provides color, line styles, etc.
The base class for all of the Matplotlib event handling. Derived classes such as KeyEvent and MouseEvent store the meta data like keys and buttons pressed, x and y locations in pixel and Axes coordinates.
The base class for the Show class of each interactive backend; the 'show' callable is then set to Show.__call__.
The base class for the Toolbar class of each interactive backend.
Bases: matplotlib.backend_bases.Event
An event triggered by a figure being closed.
Bases: matplotlib.backend_bases.Event
An event triggered by a draw operation on the canvas.
In most backends, callbacks subscribed to this event will be fired after the rendering is complete but before the screen is updated. Any extra artists drawn to the canvas's renderer will be reflected without an explicit call to blit.
Warning
Calling canvas.draw and canvas.blit in these callbacks may not be safe with all backends and may cause infinite recursion.
A DrawEvent has a number of special attributes in addition to those defined by the parent Event class.
The renderer for the draw event.
Bases: object
A Matplotlib event.
The following attributes are defined and shown with their default values. Subclasses may define additional attributes.
The event name.
The backend-specific canvas instance generating the event.
The GUI event that triggered the Matplotlib event.
Bases: object
The canvas the figure renders into.
A high-level figure instance.
Blit the canvas in bbox (default entire canvas).
Callback processing for mouse button press events.
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.
This method will call all functions connected to the 'button_press_event' with a MouseEvent instance.
Callback processing for mouse button release events.
Backend derived classes should call this function on any mouse button release.
This method will call all functions connected to the 'button_release_event' with a MouseEvent instance.
The canvas coordinates where 0=left.
The canvas coordinates where 0=bottom.
The native UI event that generated the Matplotlib event.
Pass a CloseEvent to all functions connected to close_event.
The ratio of physical to logical pixels used for the canvas on screen.
By default, this is 1, meaning physical and logical pixels are the same size. Subclasses that support High DPI screens may set this property to indicate that said ratio is different. All Matplotlib interaction, unless working directly with the canvas, remains in logical pixels.
Render the Figure.
It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.
Pass a DrawEvent to all functions connected to draw_event.
Request a widget redraw once control returns to the GUI event loop.
Even if multiple calls to draw_idle occur before control returns to the GUI event loop, the figure will only be rendered once.
Backends may choose to override the method and implement their own strategy to prevent multiple renderings.
Callback processing for the mouse cursor entering the canvas.
Backend derived classes should call this function when entering canvas.
The native UI event that generated the Matplotlib event.
The coordinate location of the pointer when the canvas is entered.
Flush the GUI events for the figure.
Interactive backends need to reimplement this method.
Return a string, which includes extension, suitable for use as a default filename.
Return the default savefig file format as specified in rcParams["savefig.format"] (default: 'png').
The returned string does not include a period. This method is overridden in backends that only support a single file type.
Return dict of savefig file formats supported by this backend.
Return a dict of savefig file formats supported by this backend, where the keys are a file type name, such as 'Joint Photographic Experts Group', and the values are a list of filename extensions used for that filetype, such as ['jpg', 'jpeg'].
Return the figure width and height in integral points or pixels.
When the figure is used on High DPI screens (and the backend supports it), the truncation to integers occurs after scaling by the device pixel ratio.
Whether to return true physical pixels or logical pixels. Physical pixels may be used by backends that support HiDPI, but still configure the canvas using its actual size.
The size of the figure, in points or pixels, depending on the backend.
[Deprecated] Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).
Deprecated since version 3.4.
Set the child Axes which is grabbing the mouse events.
Usually called by the widgets themselves. It is an error to call this if the mouse is already grabbed by another axes.
Return the topmost visible Axes containing the point xy.
(x, y) pixel positions from left/bottom of the canvas.
The topmost visible axes containing the point, or None if no axes.
Return whether the renderer is in the process of saving to a file, rather than rendering for an on-screen buffer.
Pass a KeyEvent to all functions connected to key_press_event.
Pass a KeyEvent to all functions connected to key_release_event.
Callback processing for the mouse cursor leaving the canvas.
Backend derived classes should call this function when leaving canvas.
The native UI event that generated the Matplotlib event.
Callback processing for mouse movement events.
Backend derived classes should call this function on any motion-notify-event.
This method will call all functions connected to the 'motion_notify_event' with a MouseEvent instance.
The canvas coordinates where 0=left.
The canvas coordinates where 0=bottom.
The native UI event that generated the Matplotlib event.
Bind function func to event s.
One of the following events ids:
The callback function to be executed, which must have the signature:
For the location events (button and key press/release), if the mouse is over the axes, the inaxes attribute of the event will be set to the Axes the event occurs is over, and additionally, the variables xdata and ydata attributes will be set to the mouse location in data coordinates. See KeyEvent and MouseEvent for more info.
A connection id that can be used with FigureCanvasBase.mpl_disconnect.
Disconnect the callback with id cid.
Create a new backend-specific subclass of Timer.
This is useful for getting periodic events through the backend's native event loop. Implemented only for backends with GUIs.
Timer interval in milliseconds.
Sequence of (func, args, kwargs) where func(*args, **kwargs) will be executed by the timer every interval.
Callbacks which return False or 0 will be removed from the timer.
Callback processing for pick events.
This method will be called by artists who are picked and will fire off PickEvent callbacks registered listeners.
Note that artists are not pickable by default (see Artist.set_picker).
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.
The file where the figure is saved.
The dots per inch to save the figure in.
The facecolor of the figure. If 'auto', use the current figure facecolor.
The edgecolor of the figure. If 'auto', use the current figure edgecolor.
Only currently applies to PostScript printing.
Force a specific file format. If not given, the format is inferred from the filename extension, and if that fails from rcParams["savefig.format"] (default: 'png').
Bounding box in inches: only the given portion of the figure is saved. If 'tight', try to figure out the tight bbox of the figure.
Amount of padding around the figure when bbox_inches is 'tight'.
A list of extra artists that will be considered when the tight bbox is calculated.
Use a non-default backend to render the file, e.g. to render a png file with the "cairo" backend rather than the default "agg", or a pdf file with the "pgf" backend rather than the default "pdf". Note that the default backend is normally sufficient. See The builtin backends for a list of valid backends for each file format. Custom backends can be referenced as "module://...".
Release the mouse grab held by the Axes ax.
Usually called by the widgets. It is ok to call this even if ax doesn't have the mouse grab currently.
UNUSED: Set the canvas size in pixels.
Certain backends may implement a similar method internally, but this is not a requirement of, nor is it used by, Matplotlib itself.
Pass a ResizeEvent to all functions connected to resize_event.
Callback processing for scroll events.
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.
This method will call all functions connected to the 'scroll_event' with a MouseEvent instance.
Set the current cursor.
This may have no effect if the backend does not display anything.
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.
The cursor to display over the canvas. Note: some backends may change the cursor for the entire window.
[Deprecated] Set the title text of the window containing the figure. Note that this has no effect if there is no window (e.g., a PS backend).
Deprecated since version 3.4.
Start a blocking event loop.
Such an event loop is used by interactive functions, such as ginput and waitforbuttonpress, to wait for events.
The event loop blocks until a callback function triggers stop_event_loop, or timeout is reached.
If timeout is 0 or negative, never timeout.
Only interactive backends need to reimplement this method and it relies on flush_events being properly implemented.
Interactive backends should implement this in a more native way.
Stop the current blocking event loop.
Interactive backends need to reimplement this to match start_event_loop
Instantiate an instance of FigureCanvasClass
This is used for backend switching, e.g., to instantiate a FigureCanvasPS from a FigureCanvasGTK. Note, deep copying is not done, so any changes to one of the instances (e.g., setting figure size or line props), will be reflected in the other
Bases: object
A backend-independent abstraction of a figure container and controller.
The figure manager is used by pyplot to interact with the window in a backend-independent way. It's an adapter for the real (GUI) framework that represents the visual figure on screen.
GUI backends define from this class to translate common operations such as show or resize to the GUI-specific code. Non-GUI backends do not support these operations an can just use the base class.
This following basic operations are accessible:
Window operations
Key and mouse button press handling
The figure manager sets up default key and mouse button press handling by hooking up the key_press_handler to the matplotlib event system. This ensures the same shortcuts and mouse actions across backends.
Other operations
Subclasses will have additional attributes and functions to access additional functionality. This is of course backend-specific. For example, most GUI backends have window and toolbar attributes that give access to the native GUI widgets of the respective framework.
The backend-specific canvas instance.
The figure number.
The default key handler cid, when using the toolmanager. To disable the default key press handling use:
The default mouse button handler cid, when using the toolmanager. To disable the default button press handling use:
[Deprecated] The default Matplotlib button actions for extra mouse buttons.
Deprecated since version 3.4.
Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).
[Deprecated] Implement the default Matplotlib key bindings defined at Navigation keyboard shortcuts.
Deprecated since version 3.4.
For GUI backends, resize the window (in physical pixels).
Set the title text of the window containing the figure.
This has no effect for non-GUI (e.g., PS) backends.
For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.
Bases: object
An abstract base class that provides color, line styles, etc.
Copy properties from gc to self.
Return the alpha value used for blending - not supported on all backends.
Return whether the object should try to do antialiased rendering.
Return the CapStyle.
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.
Return the clip rectangle as a Bbox instance.
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).
Return whether the value given by get_alpha() should be used to override any other alpha-channel values.
Return the object identifier if one is set, None otherwise.
Get the current hatch style.
Get the hatch color.
Get the hatch linewidth.
Return a Path for the current hatch.
Return the JoinStyle.
Return the line width in points.
Return a tuple of three or four floats from 0-1.
Return the sketch parameters for the artist.
A 3-tuple with the following elements:
May return None if no sketch parameters were set.
Return the snap setting, which can be:
Return a url if one is set, None otherwise.
Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack.
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.
Set whether object should be drawn with antialiased rendering.
Set how to draw endpoints of lines.
Set the clip path to a TransformedPath or None.
Set the clip rectangle to a Bbox or None.
Set the dash style for the gc.
The offset (usually 0).
The on-off sequence as points. None specifies a solid line.
See p. 107 of to PostScript blue book for more info.
Set the foreground color.
If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance.
Set the id.
Set the hatch style (for fills).
Set the hatch color.
Set how to draw connections between line segments.
Set the linewidth in points.
Set the sketch parameters.
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.
The length of the wiggle along the line, in pixels.
The scale factor by which the length is shrunken or expanded.
Set the snap setting which may be:
Set the url for links in compatible backends.
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.
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.
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").
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.
Event location in pixels from bottom left of canvas.
The Axes instance over which the mouse is, if any.
Data coordinates of the mouse within inaxes, or None if the mouse is not over an Axes.
Bases: enum.IntEnum
An enumeration.
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.
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.
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.
The number of scroll steps (positive for 'up', negative for 'down'). This applies only to 'scroll_event' and defaults to 0 otherwise.
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'.
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 the current figure
draw the zoom to rect "rubberband" rectangle
display message
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!
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.
Callback for dragging in pan/zoom mode.
Callback for dragging in zoom mode.
Draw a rectangle rubberband to indicate zoom limits.
Note that it is not guaranteed that x0 <= x1 and y0 <= y1.
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.
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.
Toggle the pan/zoom tool.
Pan with left button, zoom with right.
Callback for mouse button press in pan/zoom mode.
Callback for mouse button press in zoom to rect mode.
Push the current view limits and position onto the stack.
Callback for mouse button release in pan/zoom mode.
Callback for mouse button release in zoom to rect mode.
Remove the rubberband.
Save the current figure.
[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.
Deprecated since version 3.5.
Enable or disable the back/forward button.
Display a message on toolbar or in status bar.
Reset the axes stack.
Toggle zoom to rect mode.
Bases: Exception
Raised when trying show a figure in a non-GUI backend.
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.
Bind a function on_pick() to pick events, that prints the coordinates of the picked data point:
The mouse event that generated the pick.
The picked artist. Note that artists are not pickable by default (see Artist.set_picker).
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.
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):
The following methods should be implemented in the backend for optimization reasons:
Close a grouping element with label s.
Only used by the SVG renderer.
Draw a Gouraud-shaded triangle.
The graphics context.
Array of (x, y) points for the triangle.
RGBA colors for each point of the triangle.
An affine transform to apply to the points.
Draw a series of Gouraud triangles.
Array of N (x, y) points for the triangles.
Array of N RGBA colors for each point of the triangles.
An affine transform to apply to the points.
Draw an RGBA image.
A graphics context with clipping information.
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
An array of RGBA pixels.
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 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.
The graphics context.
An affine transform applied to the marker.
An affine transform applied to the path.
Draw a Path instance using the given affine transform.
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.
Fallback implementation of draw_quad_mesh() that generates paths and then calls draw_path_collection().
Draw the text instance.
The graphics context.
The x location of the text in display coords.
The y location of the text baseline in display coords.
The text string.
The font properties.
The rotation angle in degrees anti-clockwise.
The original text object to be rendered.
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:
to if 1, and then the actual bounding box will be plotted along with your text.
Return whether y values increase from top to bottom.
Note that this only affects drawing of texts and images.
Return the canvas width and height in display coords.
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.
Return the TexManager instance.
Get the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop.
Return an instance of a GraphicsContextBase.
Open a grouping element with label s and gid (if set) as id.
Only used by the SVG renderer.
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"].
Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends).
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:
a float or a numpy array of float
Switch to a temporary renderer for image filtering effects.
Currently only supported by the agg renderer.
Switch to the raster renderer.
Used by MixedModeRenderer.
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.
Switch back to the vector renderer and draw the contents of the raster renderer as an image on the vector renderer.
Used by MixedModeRenderer.
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.
Width of the canvas in pixels.
Height of the canvas in pixels.
Bases: matplotlib.backend_bases._Backend
Simple base class to generate a show() function in backends.
Subclass must override mainloop() method.
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:
Subclasses may additionally override the following methods:
The time between timer events in milliseconds. Will be stored as timer.interval.
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.
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.
The time between timer events, in milliseconds.
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.
Whether this timer should stop after a single run.
Start the timer object.
Timer interval in milliseconds; overrides a previously set interval if provided.
Stop the timer.
Bases: object
Base class for all tool containers, e.g. toolbars.
The tools with which this ToolContainer wants to communicate.
Add a tool to this container.
The tool to add, see ToolManager.get_tool.
The name of the group to add this tool to.
The position within the group to place this tool.
Add a toolitem to the container.
This method must be implemented per backend.
The callback associated with the button click event, must be exactly self.trigger_tool(name).
Name of the tool to add, this gets used as the tool's ID and as the default label of the buttons.
Name of the group that this tool belongs to.
Position of the tool within its group, if -1 it goes at the end.
Filename of the image for the button or None.
Description of the tool, used for the tooltips.
Remove a toolitem from the ToolContainer.
This method must get implemented per backend.
Called when ToolManager emits a tool_removed_event.
Name of the tool to remove.
Display a message on the toolbar.
Message text.
Toggle the toolitem without firing event.
Id of the tool to toggle.
Whether to set this tool as toggled or not.
Trigger the tool.
Name (id) of the tool triggered from within the container.
The default Matplotlib button actions for extra mouse buttons.
Parameters are as for key_press_handler, except that event is a MouseEvent.
Return the registered default canvas for given file format. Handles deferred import of required backend.
Implement the default Matplotlib key bindings for the canvas and toolbar described at Navigation keyboard shortcuts.
A key press/release event.
The backend-specific canvas instance. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.
The navigation cursor toolbar. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.toolbar.
Register a backend for saving to a given file format.
File extension
Backend for handling file output
Description of the file type.


The default Matplotlib button actions for extra mouse buttons.
Parameters are as for key_press_handler, except that event is a MouseEvent.


Bases: matplotlib.backend_bases.Event
An event triggered by a figure being closed.


Bases: matplotlib.backend_bases.Event
An event triggered by a draw operation on the canvas.
In most backends, callbacks subscribed to this event will be fired after the rendering is complete but before the screen is updated. Any extra artists drawn to the canvas's renderer will be reflected without an explicit call to blit.
Warning
Calling canvas.draw and canvas.blit in these callbacks may not be safe with all backends and may cause infinite recursion.
A DrawEvent has a number of special attributes in addition to those defined by the parent Event class.
The renderer for the draw event.


Bases: object
A Matplotlib event.
The following attributes are defined and shown with their default values. Subclasses may define additional attributes.
The event name.
The backend-specific canvas instance generating the event.
The GUI event that triggered the Matplotlib event.


Bases: object
The canvas the figure renders into.
A high-level figure instance.
Blit the canvas in bbox (default entire canvas).
Callback processing for mouse button press events.
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.
This method will call all functions connected to the 'button_press_event' with a MouseEvent instance.
Callback processing for mouse button release events.
Backend derived classes should call this function on any mouse button release.
This method will call all functions connected to the 'button_release_event' with a MouseEvent instance.
The canvas coordinates where 0=left.
The canvas coordinates where 0=bottom.
The native UI event that generated the Matplotlib event.
Pass a CloseEvent to all functions connected to close_event.
The ratio of physical to logical pixels used for the canvas on screen.
By default, this is 1, meaning physical and logical pixels are the same size. Subclasses that support High DPI screens may set this property to indicate that said ratio is different. All Matplotlib interaction, unless working directly with the canvas, remains in logical pixels.
Render the Figure.
It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.
Pass a DrawEvent to all functions connected to draw_event.
Request a widget redraw once control returns to the GUI event loop.
Even if multiple calls to draw_idle occur before control returns to the GUI event loop, the figure will only be rendered once.
Backends may choose to override the method and implement their own strategy to prevent multiple renderings.
Callback processing for the mouse cursor entering the canvas.
Backend derived classes should call this function when entering canvas.
The native UI event that generated the Matplotlib event.
The coordinate location of the pointer when the canvas is entered.
Flush the GUI events for the figure.
Interactive backends need to reimplement this method.
Return a string, which includes extension, suitable for use as a default filename.
Return the default savefig file format as specified in rcParams["savefig.format"] (default: 'png').
The returned string does not include a period. This method is overridden in backends that only support a single file type.
Return dict of savefig file formats supported by this backend.
Return a dict of savefig file formats supported by this backend, where the keys are a file type name, such as 'Joint Photographic Experts Group', and the values are a list of filename extensions used for that filetype, such as ['jpg', 'jpeg'].
Return the figure width and height in integral points or pixels.
When the figure is used on High DPI screens (and the backend supports it), the truncation to integers occurs after scaling by the device pixel ratio.
Whether to return true physical pixels or logical pixels. Physical pixels may be used by backends that support HiDPI, but still configure the canvas using its actual size.
The size of the figure, in points or pixels, depending on the backend.
[Deprecated] Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).
Deprecated since version 3.4.
Set the child Axes which is grabbing the mouse events.
Usually called by the widgets themselves. It is an error to call this if the mouse is already grabbed by another axes.
Return the topmost visible Axes containing the point xy.
(x, y) pixel positions from left/bottom of the canvas.
The topmost visible axes containing the point, or None if no axes.
Return whether the renderer is in the process of saving to a file, rather than rendering for an on-screen buffer.
Pass a KeyEvent to all functions connected to key_press_event.
Pass a KeyEvent to all functions connected to key_release_event.
Callback processing for the mouse cursor leaving the canvas.
Backend derived classes should call this function when leaving canvas.
The native UI event that generated the Matplotlib event.
Callback processing for mouse movement events.
Backend derived classes should call this function on any motion-notify-event.
This method will call all functions connected to the 'motion_notify_event' with a MouseEvent instance.
The canvas coordinates where 0=left.
The canvas coordinates where 0=bottom.
The native UI event that generated the Matplotlib event.
Bind function func to event s.
One of the following events ids:
The callback function to be executed, which must have the signature:
For the location events (button and key press/release), if the mouse is over the axes, the inaxes attribute of the event will be set to the Axes the event occurs is over, and additionally, the variables xdata and ydata attributes will be set to the mouse location in data coordinates. See KeyEvent and MouseEvent for more info.
A connection id that can be used with FigureCanvasBase.mpl_disconnect.
Disconnect the callback with id cid.
Create a new backend-specific subclass of Timer.
This is useful for getting periodic events through the backend's native event loop. Implemented only for backends with GUIs.
Timer interval in milliseconds.
Sequence of (func, args, kwargs) where func(*args, **kwargs) will be executed by the timer every interval.
Callbacks which return False or 0 will be removed from the timer.
Callback processing for pick events.
This method will be called by artists who are picked and will fire off PickEvent callbacks registered listeners.
Note that artists are not pickable by default (see Artist.set_picker).
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.
The file where the figure is saved.
The dots per inch to save the figure in.
The facecolor of the figure. If 'auto', use the current figure facecolor.
The edgecolor of the figure. If 'auto', use the current figure edgecolor.
Only currently applies to PostScript printing.
Force a specific file format. If not given, the format is inferred from the filename extension, and if that fails from rcParams["savefig.format"] (default: 'png').
Bounding box in inches: only the given portion of the figure is saved. If 'tight', try to figure out the tight bbox of the figure.
Amount of padding around the figure when bbox_inches is 'tight'.
A list of extra artists that will be considered when the tight bbox is calculated.
Use a non-default backend to render the file, e.g. to render a png file with the "cairo" backend rather than the default "agg", or a pdf file with the "pgf" backend rather than the default "pdf". Note that the default backend is normally sufficient. See The builtin backends for a list of valid backends for each file format. Custom backends can be referenced as "module://...".
Release the mouse grab held by the Axes ax.
Usually called by the widgets. It is ok to call this even if ax doesn't have the mouse grab currently.
UNUSED: Set the canvas size in pixels.
Certain backends may implement a similar method internally, but this is not a requirement of, nor is it used by, Matplotlib itself.
Pass a ResizeEvent to all functions connected to resize_event.
Callback processing for scroll events.
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.
This method will call all functions connected to the 'scroll_event' with a MouseEvent instance.
Set the current cursor.
This may have no effect if the backend does not display anything.
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.
The cursor to display over the canvas. Note: some backends may change the cursor for the entire window.
[Deprecated] Set the title text of the window containing the figure. Note that this has no effect if there is no window (e.g., a PS backend).
Deprecated since version 3.4.
Start a blocking event loop.
Such an event loop is used by interactive functions, such as ginput and waitforbuttonpress, to wait for events.
The event loop blocks until a callback function triggers stop_event_loop, or timeout is reached.
If timeout is 0 or negative, never timeout.
Only interactive backends need to reimplement this method and it relies on flush_events being properly implemented.
Interactive backends should implement this in a more native way.
Stop the current blocking event loop.
Interactive backends need to reimplement this to match start_event_loop
Instantiate an instance of FigureCanvasClass
This is used for backend switching, e.g., to instantiate a FigureCanvasPS from a FigureCanvasGTK. Note, deep copying is not done, so any changes to one of the instances (e.g., setting figure size or line props), will be reflected in the other


Blit the canvas in bbox (default entire canvas).


Callback processing for mouse button press events.
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.
This method will call all functions connected to the 'button_press_event' with a MouseEvent instance.


Callback processing for mouse button release events.
Backend derived classes should call this function on any mouse button release.
This method will call all functions connected to the 'button_release_event' with a MouseEvent instance.
The canvas coordinates where 0=left.
The canvas coordinates where 0=bottom.
The native UI event that generated the Matplotlib event.


Pass a CloseEvent to all functions connected to close_event.


Render the Figure.
It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.


Pass a DrawEvent to all functions connected to draw_event.


Request a widget redraw once control returns to the GUI event loop.
Even if multiple calls to draw_idle occur before control returns to the GUI event loop, the figure will only be rendered once.
Backends may choose to override the method and implement their own strategy to prevent multiple renderings.


Callback processing for the mouse cursor entering the canvas.
Backend derived classes should call this function when entering canvas.
The native UI event that generated the Matplotlib event.
The coordinate location of the pointer when the canvas is entered.


Flush the GUI events for the figure.
Interactive backends need to reimplement this method.


Return a string, which includes extension, suitable for use as a default filename.


Return the default savefig file format as specified in rcParams["savefig.format"] (default: 'png').
The returned string does not include a period. This method is overridden in backends that only support a single file type.


Return dict of savefig file formats supported by this backend.


Return a dict of savefig file formats supported by this backend, where the keys are a file type name, such as 'Joint Photographic Experts Group', and the values are a list of filename extensions used for that filetype, such as ['jpg', 'jpeg'].


Return the figure width and height in integral points or pixels.
When the figure is used on High DPI screens (and the backend supports it), the truncation to integers occurs after scaling by the device pixel ratio.
Whether to return true physical pixels or logical pixels. Physical pixels may be used by backends that support HiDPI, but still configure the canvas using its actual size.
The size of the figure, in points or pixels, depending on the backend.


[Deprecated] Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).
Deprecated since version 3.4.


Set the child Axes which is grabbing the mouse events.
Usually called by the widgets themselves. It is an error to call this if the mouse is already grabbed by another axes.


Return the topmost visible Axes containing the point xy.
(x, y) pixel positions from left/bottom of the canvas.
The topmost visible axes containing the point, or None if no axes.


Return whether the renderer is in the process of saving to a file, rather than rendering for an on-screen buffer.


Pass a KeyEvent to all functions connected to key_press_event.


Pass a KeyEvent to all functions connected to key_release_event.


Callback processing for the mouse cursor leaving the canvas.
Backend derived classes should call this function when leaving canvas.
The native UI event that generated the Matplotlib event.


Callback processing for mouse movement events.
Backend derived classes should call this function on any motion-notify-event.
This method will call all functions connected to the 'motion_notify_event' with a MouseEvent instance.
The canvas coordinates where 0=left.
The canvas coordinates where 0=bottom.
The native UI event that generated the Matplotlib event.


Bind function func to event s.
One of the following events ids:
The callback function to be executed, which must have the signature:
For the location events (button and key press/release), if the mouse is over the axes, the inaxes attribute of the event will be set to the Axes the event occurs is over, and additionally, the variables xdata and ydata attributes will be set to the mouse location in data coordinates. See KeyEvent and MouseEvent for more info.
A connection id that can be used with FigureCanvasBase.mpl_disconnect.


Create a new backend-specific subclass of Timer.
This is useful for getting periodic events through the backend's native event loop. Implemented only for backends with GUIs.
Timer interval in milliseconds.
Sequence of (func, args, kwargs) where func(*args, **kwargs) will be executed by the timer every interval.
Callbacks which return False or 0 will be removed from the timer.


Callback processing for pick events.
This method will be called by artists who are picked and will fire off PickEvent callbacks registered listeners.
Note that artists are not pickable by default (see Artist.set_picker).


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.
The file where the figure is saved.
The dots per inch to save the figure in.
The facecolor of the figure. If 'auto', use the current figure facecolor.
The edgecolor of the figure. If 'auto', use the current figure edgecolor.
Only currently applies to PostScript printing.
Force a specific file format. If not given, the format is inferred from the filename extension, and if that fails from rcParams["savefig.format"] (default: 'png').
Bounding box in inches: only the given portion of the figure is saved. If 'tight', try to figure out the tight bbox of the figure.
Amount of padding around the figure when bbox_inches is 'tight'.
A list of extra artists that will be considered when the tight bbox is calculated.
Use a non-default backend to render the file, e.g. to render a png file with the "cairo" backend rather than the default "agg", or a pdf file with the "pgf" backend rather than the default "pdf". Note that the default backend is normally sufficient. See The builtin backends for a list of valid backends for each file format. Custom backends can be referenced as "module://...".


Release the mouse grab held by the Axes ax.
Usually called by the widgets. It is ok to call this even if ax doesn't have the mouse grab currently.


UNUSED: Set the canvas size in pixels.
Certain backends may implement a similar method internally, but this is not a requirement of, nor is it used by, Matplotlib itself.


Pass a ResizeEvent to all functions connected to resize_event.


Callback processing for scroll events.
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.
This method will call all functions connected to the 'scroll_event' with a MouseEvent instance.


Set the current cursor.
This may have no effect if the backend does not display anything.
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.
The cursor to display over the canvas. Note: some backends may change the cursor for the entire window.


[Deprecated] Set the title text of the window containing the figure. Note that this has no effect if there is no window (e.g., a PS backend).
Deprecated since version 3.4.


Start a blocking event loop.
Such an event loop is used by interactive functions, such as ginput and waitforbuttonpress, to wait for events.
The event loop blocks until a callback function triggers stop_event_loop, or timeout is reached.
If timeout is 0 or negative, never timeout.
Only interactive backends need to reimplement this method and it relies on flush_events being properly implemented.
Interactive backends should implement this in a more native way.


Stop the current blocking event loop.
Interactive backends need to reimplement this to match start_event_loop


Instantiate an instance of FigureCanvasClass
This is used for backend switching, e.g., to instantiate a FigureCanvasPS from a FigureCanvasGTK. Note, deep copying is not done, so any changes to one of the instances (e.g., setting figure size or line props), will be reflected in the other


Bases: object
A backend-independent abstraction of a figure container and controller.
The figure manager is used by pyplot to interact with the window in a backend-independent way. It's an adapter for the real (GUI) framework that represents the visual figure on screen.
GUI backends define from this class to translate common operations such as show or resize to the GUI-specific code. Non-GUI backends do not support these operations an can just use the base class.
This following basic operations are accessible:
Window operations
Key and mouse button press handling
The figure manager sets up default key and mouse button press handling by hooking up the key_press_handler to the matplotlib event system. This ensures the same shortcuts and mouse actions across backends.
Other operations
Subclasses will have additional attributes and functions to access additional functionality. This is of course backend-specific. For example, most GUI backends have window and toolbar attributes that give access to the native GUI widgets of the respective framework.
The backend-specific canvas instance.
The figure number.
The default key handler cid, when using the toolmanager. To disable the default key press handling use:
The default mouse button handler cid, when using the toolmanager. To disable the default button press handling use:
[Deprecated] The default Matplotlib button actions for extra mouse buttons.
Deprecated since version 3.4.
Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).
[Deprecated] Implement the default Matplotlib key bindings defined at Navigation keyboard shortcuts.
Deprecated since version 3.4.
For GUI backends, resize the window (in physical pixels).
Set the title text of the window containing the figure.
This has no effect for non-GUI (e.g., PS) backends.
For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.


[Deprecated] The default Matplotlib button actions for extra mouse buttons.
Deprecated since version 3.4.


Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).


[Deprecated] Implement the default Matplotlib key bindings defined at Navigation keyboard shortcuts.
Deprecated since version 3.4.


For GUI backends, resize the window (in physical pixels).


Set the title text of the window containing the figure.
This has no effect for non-GUI (e.g., PS) backends.


For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.


Return the registered default canvas for given file format. Handles deferred import of required backend.


Bases: object
An abstract base class that provides color, line styles, etc.
Copy properties from gc to self.
Return the alpha value used for blending - not supported on all backends.
Return whether the object should try to do antialiased rendering.
Return the CapStyle.
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.
Return the clip rectangle as a Bbox instance.
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).
Return whether the value given by get_alpha() should be used to override any other alpha-channel values.
Return the object identifier if one is set, None otherwise.
Get the current hatch style.
Get the hatch color.
Get the hatch linewidth.
Return a Path for the current hatch.
Return the JoinStyle.
Return the line width in points.
Return a tuple of three or four floats from 0-1.
Return the sketch parameters for the artist.
A 3-tuple with the following elements:
May return None if no sketch parameters were set.
Return the snap setting, which can be:
Return a url if one is set, None otherwise.
Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack.
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.
Set whether object should be drawn with antialiased rendering.
Set how to draw endpoints of lines.
Set the clip path to a TransformedPath or None.
Set the clip rectangle to a Bbox or None.
Set the dash style for the gc.
The offset (usually 0).
The on-off sequence as points. None specifies a solid line.
See p. 107 of to PostScript blue book for more info.
Set the foreground color.
If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance.
Set the id.
Set the hatch style (for fills).
Set the hatch color.
Set how to draw connections between line segments.
Set the linewidth in points.
Set the sketch parameters.
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.
The length of the wiggle along the line, in pixels.
The scale factor by which the length is shrunken or expanded.
Set the snap setting which may be:
Set the url for links in compatible backends.


Return the alpha value used for blending - not supported on all backends.


Return whether the object should try to do antialiased rendering.


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.


Return the clip rectangle as a Bbox instance.


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).


Return whether the value given by get_alpha() should be used to override any other alpha-channel values.


Return the object identifier if one is set, None otherwise.


Return a tuple of three or four floats from 0-1.


Return the sketch parameters for the artist.
A 3-tuple with the following elements:
May return None if no sketch parameters were set.


Return a url if one is set, None otherwise.


Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack.


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.


Set whether object should be drawn with antialiased rendering.


Set the clip path to a TransformedPath or None.


Set the clip rectangle to a Bbox or None.


Set the dash style for the gc.
The offset (usually 0).
The on-off sequence as points. None specifies a solid line.
See p. 107 of to PostScript blue book for more info.


Set the foreground color.
If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance.


Set how to draw connections between line segments.


Set the sketch parameters.
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.
The length of the wiggle along the line, in pixels.
The scale factor by which the length is shrunken or expanded.


Set the url for links in compatible backends.


Implement the default Matplotlib key bindings for the canvas and toolbar described at Navigation keyboard shortcuts.
A key press/release event.
The backend-specific canvas instance. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.
The navigation cursor toolbar. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.toolbar.


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.
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.
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").


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.
Event location in pixels from bottom left of canvas.
The Axes instance over which the mouse is, if any.
Data coordinates of the mouse within inaxes, or None if the mouse is not over an Axes.


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.
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.
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.
The number of scroll steps (positive for 'up', negative for 'down'). This applies only to 'scroll_event' and defaults to 0 otherwise.
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'.


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 the current figure
draw the zoom to rect "rubberband" rectangle
display message
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!
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.
Callback for dragging in pan/zoom mode.
Callback for dragging in zoom mode.
Draw a rectangle rubberband to indicate zoom limits.
Note that it is not guaranteed that x0 <= x1 and y0 <= y1.
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.
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.
Toggle the pan/zoom tool.
Pan with left button, zoom with right.
Callback for mouse button press in pan/zoom mode.
Callback for mouse button press in zoom to rect mode.
Push the current view limits and position onto the stack.
Callback for mouse button release in pan/zoom mode.
Callback for mouse button release in zoom to rect mode.
Remove the rubberband.
Save the current figure.
[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.
Deprecated since version 3.5.
Enable or disable the back/forward button.
Display a message on toolbar or in status bar.
Reset the axes stack.
Toggle zoom to rect mode.


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.


Draw a rectangle rubberband to indicate zoom limits.
Note that it is not guaranteed that x0 <= x1 and y0 <= y1.


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.


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.


Toggle the pan/zoom tool.
Pan with left button, zoom with right.


Callback for mouse button press in pan/zoom mode.


Callback for mouse button press in zoom to rect mode.


Push the current view limits and position onto the stack.


Callback for mouse button release in pan/zoom mode.


Callback for mouse button release in zoom to rect mode.


[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.
Deprecated since version 3.5.


Enable or disable the back/forward button.


Display a message on toolbar or in status bar.


Bases: Exception
Raised when trying show a figure in a non-GUI backend.


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.
Bind a function on_pick() to pick events, that prints the coordinates of the picked data point:
The mouse event that generated the pick.
The picked artist. Note that artists are not pickable by default (see Artist.set_picker).
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.


Register a backend for saving to a given file format.
File extension
Backend for handling file output
Description of the file type.


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):
The following methods should be implemented in the backend for optimization reasons:
Close a grouping element with label s.
Only used by the SVG renderer.
Draw a Gouraud-shaded triangle.
The graphics context.
Array of (x, y) points for the triangle.
RGBA colors for each point of the triangle.
An affine transform to apply to the points.
Draw a series of Gouraud triangles.
Array of N (x, y) points for the triangles.
Array of N RGBA colors for each point of the triangles.
An affine transform to apply to the points.
Draw an RGBA image.
A graphics context with clipping information.
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
An array of RGBA pixels.
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 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.
The graphics context.
An affine transform applied to the marker.
An affine transform applied to the path.
Draw a Path instance using the given affine transform.
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.
Fallback implementation of draw_quad_mesh() that generates paths and then calls draw_path_collection().
Draw the text instance.
The graphics context.
The x location of the text in display coords.
The y location of the text baseline in display coords.
The text string.
The font properties.
The rotation angle in degrees anti-clockwise.
The original text object to be rendered.
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:
to if 1, and then the actual bounding box will be plotted along with your text.
Return whether y values increase from top to bottom.
Note that this only affects drawing of texts and images.
Return the canvas width and height in display coords.
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.
Return the TexManager instance.
Get the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop.
Return an instance of a GraphicsContextBase.
Open a grouping element with label s and gid (if set) as id.
Only used by the SVG renderer.
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"].
Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends).
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:
a float or a numpy array of float
Switch to a temporary renderer for image filtering effects.
Currently only supported by the agg renderer.
Switch to the raster renderer.
Used by MixedModeRenderer.
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.
Switch back to the vector renderer and draw the contents of the raster renderer as an image on the vector renderer.
Used by MixedModeRenderer.


Close a grouping element with label s.
Only used by the SVG renderer.


Draw a Gouraud-shaded triangle.
The graphics context.
Array of (x, y) points for the triangle.
RGBA colors for each point of the triangle.
An affine transform to apply to the points.


Draw a series of Gouraud triangles.
Array of N (x, y) points for the triangles.
Array of N RGBA colors for each point of the triangles.
An affine transform to apply to the points.


Draw an RGBA image.
A graphics context with clipping information.
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
An array of RGBA pixels.
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 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.
The graphics context.
An affine transform applied to the marker.
An affine transform applied to the path.


Draw a Path instance using the given affine transform.


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.


Fallback implementation of draw_quad_mesh() that generates paths and then calls draw_path_collection().


Draw the text instance.
The graphics context.
The x location of the text in display coords.
The y location of the text baseline in display coords.
The text string.
The font properties.
The rotation angle in degrees anti-clockwise.
The original text object to be rendered.
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:
to if 1, and then the actual bounding box will be plotted along with your text.


Return whether y values increase from top to bottom.
Note that this only affects drawing of texts and images.


Return the canvas width and height in display coords.


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 the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop.


Return an instance of a GraphicsContextBase.


Open a grouping element with label s and gid (if set) as id.
Only used by the SVG renderer.


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"].


Return whether arbitrary affine transformations in draw_image() are supported (True for most vector backends).


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:
a float or a numpy array of float


Switch to a temporary renderer for image filtering effects.
Currently only supported by the agg renderer.


Switch to the raster renderer.
Used by MixedModeRenderer.


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.


Switch back to the vector renderer and draw the contents of the raster renderer as an image on the vector renderer.
Used by MixedModeRenderer.


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.
Width of the canvas in pixels.
Height of the canvas in pixels.


Bases: matplotlib.backend_bases._Backend
Simple base class to generate a show() function in backends.
Subclass must override mainloop() method.


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:
Subclasses may additionally override the following methods:
The time between timer events in milliseconds. Will be stored as timer.interval.
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.
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.
The time between timer events, in milliseconds.
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.
Whether this timer should stop after a single run.
Start the timer object.
Timer interval in milliseconds; overrides a previously set interval if provided.
Stop the timer.


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.


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.


Start the timer object.
Timer interval in milliseconds; overrides a previously set interval if provided.


Bases: object
Base class for all tool containers, e.g. toolbars.
The tools with which this ToolContainer wants to communicate.
Add a tool to this container.
The tool to add, see ToolManager.get_tool.
The name of the group to add this tool to.
The position within the group to place this tool.
Add a toolitem to the container.
This method must be implemented per backend.
The callback associated with the button click event, must be exactly self.trigger_tool(name).
Name of the tool to add, this gets used as the tool's ID and as the default label of the buttons.
Name of the group that this tool belongs to.
Position of the tool within its group, if -1 it goes at the end.
Filename of the image for the button or None.
Description of the tool, used for the tooltips.
Remove a toolitem from the ToolContainer.
This method must get implemented per backend.
Called when ToolManager emits a tool_removed_event.
Name of the tool to remove.
Display a message on the toolbar.
Message text.
Toggle the toolitem without firing event.
Id of the tool to toggle.
Whether to set this tool as toggled or not.
Trigger the tool.
Name (id) of the tool triggered from within the container.


Add a tool to this container.
The tool to add, see ToolManager.get_tool.
The name of the group to add this tool to.
The position within the group to place this tool.


Add a toolitem to the container.
This method must be implemented per backend.
The callback associated with the button click event, must be exactly self.trigger_tool(name).
Name of the tool to add, this gets used as the tool's ID and as the default label of the buttons.
Name of the group that this tool belongs to.
Position of the tool within its group, if -1 it goes at the end.
Filename of the image for the button or None.
Description of the tool, used for the tooltips.


Remove a toolitem from the ToolContainer.
This method must get implemented per backend.
Called when ToolManager emits a tool_removed_event.
Name of the tool to remove.


Display a message on the toolbar.
Message text.


Toggle the toolitem without firing event.
Id of the tool to toggle.
Whether to set this tool as toggled or not.


Trigger the tool.
Name (id) of the tool triggered from within the container.


Steve Chaplin and others
This backend depends on cairocffi or pycairo.
alias of matplotlib.backends.backend_cairo.FigureCanvasCairo
Bases: matplotlib.backend_bases.FigureCanvasBase
Bases: matplotlib.backend_bases.GraphicsContextBase
Return a tuple of three or four floats from 0-1.
Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack.
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.
Set whether object should be drawn with antialiased rendering.
Set how to draw endpoints of lines.
Set the clip path to a TransformedPath or None.
Set the clip rectangle to a Bbox or None.
Set the dash style for the gc.
The offset (usually 0).
The on-off sequence as points. None specifies a solid line.
See p. 107 of to PostScript blue book for more info.
Set the foreground color.
If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance.
Set how to draw connections between line segments.
Set the linewidth in points.
Bases: matplotlib.backend_bases.RendererBase
Draw an RGBA image.
A graphics context with clipping information.
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
An array of RGBA pixels.
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 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.
The graphics context.
An affine transform applied to the marker.
An affine transform applied to the path.
Draw a Path instance using the given affine transform.
Draw the text instance.
The graphics context.
The x location of the text in display coords.
The y location of the text baseline in display coords.
The text string.
The font properties.
The rotation angle in degrees anti-clockwise.
The original text object to be rendered.
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:
to if 1, and then the actual bounding box will be plotted along with your text.
Return the canvas width and height in display coords.
Get the width, height, and descent (offset from the bottom to the baseline), in display coords, of the string s with FontProperties prop.
Return an instance of a GraphicsContextBase.
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:
a float or a numpy array of float


Bases: object
Event for tool manipulation (add/remove).
Bases: object
Manager for actions triggered by user interactions (key press, toolbar clicks, ...) on a Figure.
Figure that holds the canvas.
LockDraw object to know if the canvas key_press_event is locked.
LockDraw object to know if the message is available to write.
Currently toggled tools.
Add tool to ToolManager.
If successful, adds a new event tool_trigger_{name} where {name} is the name of the tool; the event is fired every time the tool is triggered.
Name of the tool, treated as the ID, has to be unique.
Reference to find the class of the Tool to added.
See also
The base class for tools.
args and kwargs get passed directly to the tools constructor.
Canvas managed by FigureManager.
Figure that holds the canvas.
Return the tool object with the given name.
For convenience, this passes tool objects through.
Name of the tool, or the tool itself.
Whether a warning should be emitted it no tool with the given name exists.
The tool or None if no tool with the given name exists.
Return the keymap associated with the specified tool.
Name of the Tool.
List of keys associated with the tool.
Emit a ToolManagerMessageEvent.
Remove tool named name.
Name of the tool.
Bind the given figure to the tools.
Force tools to update figure.
Connect event with string s to func.
The name of the event. The following events are recognized:
For every tool added a new event is created
Callback function for the toolmanager event with signature:
The callback id for the connection. This can be used in toolmanager_disconnect.
Disconnect callback id cid.
Example usage:
A dict mapping tool name -> controlled tool.
Trigger a tool and emit the tool_trigger_{name} event.
Name of the tool.
Object that wishes to trigger the tool.
Original Canvas event or None.
Extra data to pass to the tool when triggering.
Set the keymap to associate with the specified tool.
Name of the Tool.
Keys to associate with the tool.
Bases: object
Event carrying messages from toolmanager.
Messages usually get displayed to the user by the toolbar.
Bases: matplotlib.backend_managers.ToolEvent
Event to inform that a tool has been triggered.


Bases: object
Event for tool manipulation (add/remove).


Bases: object
Manager for actions triggered by user interactions (key press, toolbar clicks, ...) on a Figure.
Figure that holds the canvas.
LockDraw object to know if the canvas key_press_event is locked.
LockDraw object to know if the message is available to write.
Currently toggled tools.
Add tool to ToolManager.
If successful, adds a new event tool_trigger_{name} where {name} is the name of the tool; the event is fired every time the tool is triggered.
Name of the tool, treated as the ID, has to be unique.
Reference to find the class of the Tool to added.
See also
The base class for tools.
args and kwargs get passed directly to the tools constructor.
Canvas managed by FigureManager.
Figure that holds the canvas.
Return the tool object with the given name.
For convenience, this passes tool objects through.
Name of the tool, or the tool itself.
Whether a warning should be emitted it no tool with the given name exists.
The tool or None if no tool with the given name exists.
Return the keymap associated with the specified tool.
Name of the Tool.
List of keys associated with the tool.
Emit a ToolManagerMessageEvent.
Remove tool named name.
Name of the tool.
Bind the given figure to the tools.
Force tools to update figure.
Connect event with string s to func.
The name of the event. The following events are recognized:
For every tool added a new event is created
Callback function for the toolmanager event with signature:
The callback id for the connection. This can be used in toolmanager_disconnect.
Disconnect callback id cid.
Example usage:
A dict mapping tool name -> controlled tool.
Trigger a tool and emit the tool_trigger_{name} event.
Name of the tool.
Object that wishes to trigger the tool.
Original Canvas event or None.
Extra data to pass to the tool when triggering.
Set the keymap to associate with the specified tool.
Name of the Tool.
Keys to associate with the tool.


Add tool to ToolManager.
If successful, adds a new event tool_trigger_{name} where {name} is the name of the tool; the event is fired every time the tool is triggered.
Name of the tool, treated as the ID, has to be unique.
Reference to find the class of the Tool to added.
See also
The base class for tools.
args and kwargs get passed directly to the tools constructor.


Return the tool object with the given name.
For convenience, this passes tool objects through.
Name of the tool, or the tool itself.
Whether a warning should be emitted it no tool with the given name exists.
The tool or None if no tool with the given name exists.


Return the keymap associated with the specified tool.
Name of the Tool.
List of keys associated with the tool.


Remove tool named name.
Name of the tool.


Bind the given figure to the tools.
Force tools to update figure.


Connect event with string s to func.
The name of the event. The following events are recognized:
For every tool added a new event is created
Callback function for the toolmanager event with signature:
The callback id for the connection. This can be used in toolmanager_disconnect.


Disconnect callback id cid.
Example usage:


Trigger a tool and emit the tool_trigger_{name} event.
Name of the tool.
Object that wishes to trigger the tool.
Original Canvas event or None.
Extra data to pass to the tool when triggering.


Set the keymap to associate with the specified tool.
Name of the Tool.
Keys to associate with the tool.


Bases: object
Event carrying messages from toolmanager.
Messages usually get displayed to the user by the toolbar.


Bases: matplotlib.backend_managers.ToolEvent
Event to inform that a tool has been triggered.


Bases: object
A helper class to implement a renderer that switches between vector and raster drawing. An example may be a PDF writer, where most things are drawn with PDF vector commands, but some very complex objects, such as quad meshes, are rasterised and then output as images.
The figure instance.
The width of the canvas in logical units
The height of the canvas in logical units
The dpi of the canvas
An instance of a subclass of RendererBase that will be used for the vector drawing.
The renderer class to use for the raster drawing. If not provided, this will use the Agg backend (which is currently the only viable option anyway.)
Enter "raster" mode. All subsequent drawing commands (until stop_rasterizing is called) will be drawn with the raster backend.
Exit "raster" mode. All of the drawing that was done since the last start_rasterizing call will be copied to the vector backend by calling draw_image.


Interactive figures in the IPython notebook.
Bases: object
Manages the Comm connection between IPython and the browser (client).
Comms are 2 way, with the CommSocket being able to publish a message via the send_json method, and handle a message with on_message. On the JS side figure.send_message and figure.ws.onmessage do the sending and receiving respectively.
alias of matplotlib.backends.backend_nbagg.FigureCanvasNbAgg
Bases: matplotlib.backends.backend_webagg_core.FigureCanvasWebAggCore
alias of matplotlib.backends.backend_nbagg.FigureManagerNbAgg
Bases: matplotlib.backends.backend_webagg_core.FigureManagerWebAgg
alias of matplotlib.backends.backend_nbagg.NavigationIPy
Clear up any closed Comms.
A special method to re-show the figure in the notebook.
For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.
Bases: matplotlib.backends.backend_webagg_core.NavigationToolbar2WebAgg
Return a string showing the figure and connection status for the backend.
This is intended as a diagnostic tool, and not for general use.
Create a new figure manager instance for the given figure.
Show all figures.
show blocks by calling mainloop if block is True, or if it is None and we are neither in IPython's %pylab mode, nor in interactive mode.


A PDF Matplotlib backend.
Author: Jouni K Seppänen <jks@iki.fi> and others.
alias of matplotlib.backends.backend_pdf.FigureCanvasPdf
Bases: matplotlib.backend_bases.FigureCanvasBase
Render the Figure.
It is important that this method actually walk the artist tree even if not output is produced because this will trigger deferred work (like computing limits auto-limits and tick values) that users may want access to before saving to disk.
Return the default savefig file format as specified in rcParams["savefig.format"] (default: 'png').
The returned string does not include a period. This method is overridden in backends that only support a single file type.
Bases: matplotlib.backend_bases.GraphicsContextBase
Set clip rectangle. Calls pop() and push().
Copy properties of other into self.
Copy properties of other into self and return PDF commands needed to transform self into other.
Predicate: does the path need to be filled?
An optional argument can be used to specify an alternative _fillcolor, as needed by RendererPdf.draw_markers.
Make sure every pushed graphics state is popped.
Return the appropriate pdf operator to cause the path to be stroked, filled, or both.
Predicate: does the path need to be stroked (its outline drawn)? This tests for the various conditions that disable stroking the path, in which case it would presumably be filled.
Bases: object
PDF name object.
Bases: matplotlib.backends.backend_pdf.Operator, enum.Enum
An enumeration.
Return the PDF operator to paint a path.
Fill the path with the fill color.
Stroke the outline of the path with the line color.
Bases: object
PDF operator object.
Bases: object
PDF file object.
Output target; if a string, a file will be opened for writing.
Information dictionary object (see PDF reference section 10.2.1 'Document Information Dictionary'), e.g.: {'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}.
The standard keys are 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate', and 'Trapped'. Values have been predefined for 'Creator', 'Producer' and 'CreationDate'. They can be removed by setting them to None.
Add a Gouraud triangle shading.
Triangle vertices, shape (n, 3, 2) where n = number of triangles, 3 = vertices, 2 = x, y.
Vertex colors, shape (n, 3, 1) or (n, 3, 4) as with points, but last dimension is either (gray,) or (r, g, b, alpha).
Return name of an ExtGState that sets alpha to the given value.
Flush all buffers and free all resources.
Given a dvi font object, return a name suitable for Op.selectfont. This registers the font information in self.dviFontInfo if not yet registered.
Embed the TTF font from the named file into the document.
Write out the various deferred objects and the pdf end matter.
Select a font based on fontprop and return a name suitable for Op.selectfont. If fontprop is a string, it will be interpreted as the filename of the font.
Return name of an image XObject representing the given image.
Return name of a marker XObject representing the given path.
Reserve an ID for an indirect object.
The name is used for debugging in case we forget to print out the object with writeObject.
Write out the info dictionary, checking it for good form
Write out the PDF trailer.
Write out the xref table.
Bases: object
A multi-page PDF file.
In reality PdfPages is a thin wrapper around PdfFile, in order to avoid confusion when using savefig and forgetting the format argument.
Create a new PdfPages object.
Plots using PdfPages.savefig will be written to a file at this location. The file is opened at once and any older file with the same name is overwritten.
If set to False, then empty pdf files will be deleted automatically when closed.
Information dictionary object (see PDF reference section 10.2.1 'Document Information Dictionary'), e.g.: {'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}.
The standard keys are 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate', and 'Trapped'. Values have been predefined for 'Creator', 'Producer' and 'CreationDate'. They can be removed by setting them to None.
Add a new text note to the page to be saved next. The optional positionRect specifies the position of the new note on the page. It is outside the page per default to make sure it is invisible on printouts.
Finalize this object, making the underlying file a complete PDF file.
Return the current number of pages in the multipage pdf file.
Return a modifiable information dictionary object (see PDF reference section 10.2.1 'Document Information Dictionary').
Save a Figure to this file as a new page.
Any other keyword arguments are passed to savefig.
The figure, or index of the figure, that is saved to the file.
Bases: object
PDF reference object.
Use PdfFile.reserveObject() to create References.
Bases: matplotlib.backends._backend_pdf_ps.RendererPDFPSBase
Draw a Gouraud-shaded triangle.
The graphics context.
Array of (x, y) points for the triangle.
RGBA colors for each point of the triangle.
An affine transform to apply to the points.
Draw a series of Gouraud triangles.
Array of N (x, y) points for the triangles.
Array of N RGBA colors for each point of the triangles.
An affine transform to apply to the points.
Draw an RGBA image.
A graphics context with clipping information.
The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.
The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.
An array of RGBA pixels.
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 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.
The graphics context.
An affine transform applied to the marker.
An affine transform applied to the path.
Draw a Path instance using the given affine transform.
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 the text instance.
The graphics context.
The x location of the text in display coords.
The y location of the text baseline in display coords.
The text string.
The font properties.
The rotation angle in degrees anti-clockwise.
The original text object to be rendered.
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:
to if 1, and then the actual bounding box will be plotted along with your text.
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.
Return an instance of a GraphicsContextBase.
Bases: object
PDF stream object.
This has no pdfRepr method. Instead, call begin(), then output the contents of the stream by calling write(), and finally call end().
Object id of the stream.
An unused Reference object for the length of the stream; None means to use a memory buffer so the length can be inlined.
The underlying object to write the stream to.
Extra key-value pairs to include in the stream header.
If the data is already png encoded, the decode parameters.
Finalize stream.
Write some data on the stream.
Bases: object
Store verbatim PDF command content for later inclusion in the stream.
Make one string from sequence of strings, with whitespace in between.
The whitespace is chosen to form lines of at most linelen characters, if possible.
Map Python objects to PDF syntax.