matplotlib.backend_tools

Abstract base classes define the primitives for Tools. These tools are used by matplotlib.backend_managers.ToolManager

ToolBase

Simple stateless tool

ToolToggleBase

Tool that has two states, only one Toggle tool can be active at any given time for the same matplotlib.backend_managers.ToolManager

class matplotlib.backend_tools.AxisScaleBase(*args, **kwargs)

Bases: ToolToggleBase

Base Tool to toggle between linear and logarithmic.

disable(event=None)

Disable the toggle tool.

trigger call this method when toggled is True.

This can happen in different circumstances.

• Click on the toolbar tool button.

• Call to matplotlib.backend_managers.ToolManager.trigger_tool.

• Another ToolToggleBase derived tool is triggered (from the same ToolManager).

enable(event=None)

Enable the toggle tool.

trigger calls this method when toggled is False.

trigger(sender, event, data=None)

Calls enable or disable based on toggled value.

class matplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)

Bases: ToolBase

Base tool for the configuration of subplots.

description = 'Configure subplots'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'subplots'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

class matplotlib.backend_tools.Cursors(value)

Bases: IntEnum

Backend-independent cursor types.

HAND = 2

MOVE = 4

POINTER = 1

RESIZE_HORIZONTAL = 6

RESIZE_VERTICAL = 7

SELECT_REGION = 3

WAIT = 5

class matplotlib.backend_tools.RubberbandBase(toolmanager, name)

Bases: ToolBase

Draw and remove a rubberband.

draw_rubberband(*data)

Draw rubberband.

This method must get implemented per backend.

remove_rubberband()

Remove rubberband.

This method should get implemented per backend.

trigger(sender, event, data=None)

Call draw_rubberband or remove_rubberband based on data.

class matplotlib.backend_tools.SaveFigureBase(toolmanager, name)

Bases: ToolBase

Base tool for figure saving.

property default_keymap

description = 'Save the figure'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'filesave'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

class matplotlib.backend_tools.SetCursorBase(*args, **kwargs)

Bases: ToolBase

Change to the current cursor while inaxes.

This tool, keeps track of all ToolToggleBase derived tools, and calls set_cursor when a tool gets triggered.

set_cursor(cursor)

[Deprecated] Set the cursor.

Notes

Deprecated since version 3.5: Use FigureCanvasBase.set_cursor instead.

set_figure(figure)

class matplotlib.backend_tools.ToolBack(toolmanager, name)

Bases: ViewsPositionsBase

Move back up the view limits stack.

property default_keymap

description = 'Back to previous view'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'back'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

class matplotlib.backend_tools.ToolBase(toolmanager, name)

Bases: object

Base tool class.

A base tool, only implements trigger method or no method at all. The tool is instantiated by matplotlib.backend_managers.ToolManager.

property canvas

The canvas of the figure affected by this tool, or None.

default_keymap = None

Keymap to associate with this tool.

list[str]: List of keys that will trigger this tool when a keypress event is emitted on self.figure.canvas. Note that this attribute is looked up on the instance, and can therefore be a property (this is used e.g. by the built-in tools to load the rcParams at instantiation time).

description = None

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

destroy()

[Deprecated] Destroy the tool.

This method is called by ToolManager.remove_tool.

Notes

Deprecated since version 3.6: Use tool_removed_event instead.

property figure

The Figure affected by this tool, or None.

image = None

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

property name

The tool id (str, must be unique among tools of a tool manager).

set_figure(figure)

property toolmanager

The ToolManager that controls this tool.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ToolCopyToClipboardBase(toolmanager, name)

Bases: ToolBase

Tool to copy the figure to the clipboard.

property default_keymap

description = 'Copy the canvas figure to clipboard'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

trigger(*args, **kwargs)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)

Bases: ToolBase

Send message with the current pointer position.

This tool runs in the background reporting the position of the cursor.

send_message(event)

Call matplotlib.backend_managers.ToolManager.message_event.

set_figure(figure)

class matplotlib.backend_tools.ToolForward(toolmanager, name)

Bases: ViewsPositionsBase

Move forward in the view lim stack.

property default_keymap

description = 'Forward to next view'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'forward'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

class matplotlib.backend_tools.ToolFullScreen(toolmanager, name)

Bases: ToolBase

Tool to toggle full screen.

property default_keymap

description = 'Toggle fullscreen mode'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ToolGrid(toolmanager, name)

Bases: ToolBase

Tool to toggle the major grids of the figure.

property default_keymap

description = 'Toggle major grids'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ToolHelpBase(toolmanager, name)

Bases: ToolBase

property default_keymap

description = 'Print tool list, shortcuts and description'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

static format_shortcut(key_sequence)

Convert a shortcut string from the notation used in rc config to the standard notation for displaying shortcuts, e.g. 'ctrl+a' -> 'Ctrl+A'.

image = 'help'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

class matplotlib.backend_tools.ToolHome(toolmanager, name)

Bases: ViewsPositionsBase

Restore the original view limits.

property default_keymap

description = 'Reset original view'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'home'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

class matplotlib.backend_tools.ToolMinorGrid(toolmanager, name)

Bases: ToolBase

Tool to toggle the major and minor grids of the figure.

property default_keymap

description = 'Toggle major and minor grids'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ToolPan(*args)

Bases: ZoomPanBase

Pan axes with left mouse, zoom with right.

cursor = 4

Cursor to use when the tool is active.

property default_keymap

description = 'Pan axes with left mouse, zoom with right'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'move'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

radio_group = 'default'

Attribute to group 'radio' like tools (mutually exclusive).

str that identifies the group or None if not belonging to a group.

class matplotlib.backend_tools.ToolQuit(toolmanager, name)

Bases: ToolBase

Tool to call the figure manager destroy method.

property default_keymap

description = 'Quit the figure'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ToolQuitAll(toolmanager, name)

Bases: ToolBase

Tool to call the figure manager destroy method.

property default_keymap

description = 'Quit all figures'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

matplotlib.backend_tools.ToolSetCursor

alias of SetCursorBase

class matplotlib.backend_tools.ToolToggleBase(*args, **kwargs)

Bases: ToolBase

Toggleable tool.

Every time it is triggered, it switches between enable and disable.

Parameters:

``*args``

Variable length argument to be used by the Tool.

``**kwargs``

toggled if present and True, sets the initial state of the Tool Arbitrary keyword arguments to be consumed by the Tool

cursor = None

Cursor to use when the tool is active.

default_toggled = False

Default of toggled state.

disable(event=None)

Disable the toggle tool.

trigger call this method when toggled is True.

This can happen in different circumstances.

• Click on the toolbar tool button.

• Call to matplotlib.backend_managers.ToolManager.trigger_tool.

• Another ToolToggleBase derived tool is triggered (from the same ToolManager).

enable(event=None)

Enable the toggle tool.

trigger calls this method when toggled is False.

radio_group = None

Attribute to group 'radio' like tools (mutually exclusive).

str that identifies the group or None if not belonging to a group.

set_figure(figure)

property toggled

State of the toggled tool.

trigger(sender, event, data=None)

Calls enable or disable based on toggled value.

class matplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)

Bases: ToolBase

Auxiliary Tool to handle changes in views and positions.

Runs in the background and should get used by all the tools that need to access the figure's history of views and positions, e.g.

• ToolZoom

• ToolPan

• ToolHome

• ToolBack

• ToolForward

add_figure(figure)

Add the current figure to the stack of views and positions.

back()

Back one step in the stack of views and positions.

clear(figure)

Reset the axes stack.

forward()

Forward one step in the stack of views and positions.

home()

Recall the first view and position from the stack.

push_current(figure=None)

Push the current view limits and position onto their respective stacks.

update_home_views(figure=None)

Make sure that self.home_views has an entry for all axes present in the figure.

update_view()

Update the view limits and position for each axes from the current stack position. If any axes are present in the figure that aren't in the current stack position, use the home view limits for those axes and don't update any positions.

class matplotlib.backend_tools.ToolXScale(*args, **kwargs)

Bases: AxisScaleBase

Tool to toggle between linear and logarithmic scales on the X axis.

property default_keymap

description = 'Toggle scale X axis'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

set_scale(ax, scale)

class matplotlib.backend_tools.ToolYScale(*args, **kwargs)

Bases: AxisScaleBase

Tool to toggle between linear and logarithmic scales on the Y axis.

property default_keymap

description = 'Toggle scale Y axis'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

set_scale(ax, scale)

class matplotlib.backend_tools.ToolZoom(*args)

Bases: ZoomPanBase

A Tool for zooming using a rectangle selector.

cursor = 3

Cursor to use when the tool is active.

property default_keymap

description = 'Zoom to rectangle'

Description of the Tool.

str: Tooltip used if the Tool is included in a Toolbar.

image = 'zoom_to_rect'

Filename of the image.

str: Filename of the image to use in a Toolbar. If None, the name is used as a label in the toolbar button.

radio_group = 'default'

Attribute to group 'radio' like tools (mutually exclusive).

str that identifies the group or None if not belonging to a group.

class matplotlib.backend_tools.ViewsPositionsBase(toolmanager, name)

Bases: ToolBase

Base class for ToolHome, ToolBack and ToolForward.

trigger(sender, event, data=None)

Called when this tool gets used.

This method is called by ToolManager.trigger_tool.

Parameters:

eventEvent

The canvas event that caused this tool to be called.

senderobject

Object that requested the tool to be triggered.

dataobject

Extra data.

class matplotlib.backend_tools.ZoomPanBase(*args)

Bases: ToolToggleBase

Base class for ToolZoom and ToolPan.

disable(event=None)

Release the canvas and disconnect press/release events.

enable(event=None)

Connect press/release events and lock the canvas.

scroll_zoom(event)

trigger(sender, event, data=None)

Calls enable or disable based on toggled value.

matplotlib.backend_tools.add_tools_to_container(container, tools=[['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save', 'help']]])

Add multiple tools to the container.

Parameters:

containerContainer

backend_bases.ToolContainerBase object that will get the tools added.

toolslist, optional

List in the form [[group1, [tool1, tool2 ...]], [group2, [...]]] where the tools [tool1, tool2, ...] will display in group1. See backend_bases.ToolContainerBase.add_tool for details.

matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'back': <class 'matplotlib.backend_tools.ToolBack'>, 'copy': <class 'matplotlib.backend_tools.ToolCopyToClipboardBase'>, 'cursor': <class 'matplotlib.backend_tools.SetCursorBase'>, 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'grid_minor': <class 'matplotlib.backend_tools.ToolMinorGrid'>, 'help': <class 'matplotlib.backend_tools.ToolHelpBase'>, 'home': <class 'matplotlib.backend_tools.ToolHome'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'>, 'rubberband': <class 'matplotlib.backend_tools.RubberbandBase'>, 'save': <class 'matplotlib.backend_tools.SaveFigureBase'>, 'subplots': <class 'matplotlib.backend_tools.ConfigureSubplotsBase'>, 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>})

Add multiple tools to a ToolManager.

Parameters:

toolmanagerbackend_managers.ToolManager

Manager to which the tools are added.

tools{str: class_like}, optional

The tools to add in a {name: tool} dict, see backend_managers.ToolManager.add_tool for more info.

matplotlib.backend_tools.cursors

alias of Cursors