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)[source]¶
Bases:
matplotlib.backend_tools.ToolToggleBase
Base Tool to toggle between linear and logarithmic.
- disable(event)[source]¶
Disable the toggle tool.
trigger
call this method whentoggled
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 sameToolManager
).
- class matplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Base tool for the configuration of subplots.
- class matplotlib.backend_tools.Cursors(value)[source]¶
Bases:
enum.IntEnum
Backend-independent cursor types.
- class matplotlib.backend_tools.RubberbandBase(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Draw and remove a rubberband.
- trigger(sender, event, data)[source]¶
Call
draw_rubberband
orremove_rubberband
based on data.
- class matplotlib.backend_tools.SaveFigureBase(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Base tool for figure saving.
- default_keymap = ['s', 'ctrl+s']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- class matplotlib.backend_tools.SetCursorBase(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Change to the current cursor while inaxes.
This tool, keeps track of all
ToolToggleBase
derived tools, and callsset_cursor
when a tool gets triggered.
- class matplotlib.backend_tools.ToolBack(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ViewsPositionsBase
Move back up the view limits stack.
- default_keymap = ['left', 'c', 'backspace', 'MouseButton.BACK']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- class matplotlib.backend_tools.ToolBase(toolmanager, name)[source]¶
Bases:
object
Base tool class.
A base tool, only implements
trigger
method or no method at all. The tool is instantiated bymatplotlib.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 onself.figure.canvas
.
- description = None¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- destroy()[source]¶
Destroy the tool.
This method is called by
ToolManager.remove_tool
.
- 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).
- property toolmanager¶
The
ToolManager
that controls this tool.
- trigger(sender, event, data=None)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ToolCopyToClipboardBase(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Tool to copy the figure to the clipboard.
- default_keymap = ['ctrl+c', 'cmd+c']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- 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)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ToolCursorPosition(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Send message with the current pointer position.
This tool runs in the background reporting the position of the cursor.
- class matplotlib.backend_tools.ToolForward(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ViewsPositionsBase
Move forward in the view lim stack.
- default_keymap = ['right', 'v', 'MouseButton.FORWARD']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- class matplotlib.backend_tools.ToolFullScreen(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.ToolToggleBase
Tool to toggle full screen.
- default_keymap = ['f', 'ctrl+f']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Toggle fullscreen mode'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- disable(event)[source]¶
Disable the toggle tool.
trigger
call this method whentoggled
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 sameToolManager
).
- class matplotlib.backend_tools.ToolGrid(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Tool to toggle the major grids of the figure.
- default_keymap = ['g']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Toggle major grids'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- trigger(sender, event, data=None)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ToolHelpBase(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
- default_keymap = ['f1']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Print tool list, shortcuts and description'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- class matplotlib.backend_tools.ToolHome(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ViewsPositionsBase
Restore the original view limits.
- default_keymap = ['h', 'r', 'home']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- class matplotlib.backend_tools.ToolMinorGrid(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Tool to toggle the major and minor grids of the figure.
- default_keymap = ['G']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- 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)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ToolPan(*args)[source]¶
Bases:
matplotlib.backend_tools.ZoomPanBase
Pan axes with left mouse, zoom with right.
- default_keymap = ['p']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Pan axes with left mouse, zoom with right'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- class matplotlib.backend_tools.ToolQuit(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Tool to call the figure manager destroy method.
- default_keymap = ['ctrl+w', 'cmd+w', 'q']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Quit the figure'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- trigger(sender, event, data=None)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ToolQuitAll(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Tool to call the figure manager destroy method.
- default_keymap = []¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Quit all figures'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- trigger(sender, event, data=None)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ToolToggleBase(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.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)[source]¶
Disable the toggle tool.
trigger
call this method whentoggled
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 sameToolManager
).
- radio_group = None¶
Attribute to group 'radio' like tools (mutually exclusive).
str
that identifies the group or None if not belonging to a group.
- property toggled¶
State of the toggled tool.
- class matplotlib.backend_tools.ToolViewsPositions(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.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.
- push_current(figure=None)[source]¶
Push the current view limits and position onto their respective stacks.
- class matplotlib.backend_tools.ToolXScale(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.AxisScaleBase
Tool to toggle between linear and logarithmic scales on the X axis.
- default_keymap = ['k', 'L']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- class matplotlib.backend_tools.ToolYScale(*args, **kwargs)[source]¶
Bases:
matplotlib.backend_tools.AxisScaleBase
Tool to toggle between linear and logarithmic scales on the Y axis.
- default_keymap = ['l']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- class matplotlib.backend_tools.ToolZoom(*args)[source]¶
Bases:
matplotlib.backend_tools.ZoomPanBase
A Tool for zooming using a rectangle selector.
- default_keymap = ['o']¶
Keymap to associate with this tool.
list[str]
: List of keys that will trigger this tool when a keypress event is emitted onself.figure.canvas
.
- description = 'Zoom to rectangle'¶
Description of the Tool.
str
: Tooltip used if the Tool is included in a Toolbar.
- class matplotlib.backend_tools.ViewsPositionsBase(toolmanager, name)[source]¶
Bases:
matplotlib.backend_tools.ToolBase
Base class for
ToolHome
,ToolBack
andToolForward
.- trigger(sender, event, data=None)[source]¶
Called when this tool gets used.
This method is called by
ToolManager.trigger_tool
.- Parameters
- event
Event
The canvas event that caused this tool to be called.
- senderobject
Object that requested the tool to be triggered.
- dataobject
Extra data.
- event
- class matplotlib.backend_tools.ZoomPanBase(*args)[source]¶
- matplotlib.backend_tools.add_tools_to_container(container, tools=[['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save', 'help']]])[source]¶
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. Seeadd_tool
for details.
- matplotlib.backend_tools.add_tools_to_manager(toolmanager, tools={'back': <class 'matplotlib.backend_tools.ToolBack'>, 'copy': 'ToolCopyToClipboard', 'cursor': 'ToolSetCursor', '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': 'ToolHelp', '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': 'ToolRubberband', 'save': 'ToolSaveFigure', 'subplots': 'ToolConfigureSubplots', 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>})[source]¶
Add multiple tools to a
ToolManager
.- Parameters
- toolmanager
backend_managers.ToolManager
Manager to which the tools are added.
- tools{str: class_like}, optional
The tools to add in a {name: tool} dict, see
add_tool
for more info.
- toolmanager
- matplotlib.backend_tools.cursors[source]¶
alias of
matplotlib.backend_tools.Cursors
- matplotlib.backend_tools.default_toolbar_tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io', ['save', 'help']]]¶
Default tools in the toolbar
- matplotlib.backend_tools.default_tools = {'back': <class 'matplotlib.backend_tools.ToolBack'>, 'copy': 'ToolCopyToClipboard', 'cursor': 'ToolSetCursor', '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': 'ToolHelp', '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': 'ToolRubberband', 'save': 'ToolSaveFigure', 'subplots': 'ToolConfigureSubplots', 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>}¶
Default tools