matplotlib.backend_tools
¶Abstract base classes define the primitives for Tools.
These tools are used by matplotlib.backend_managers.ToolManager
ToolBase
ToolToggleBase
matplotlib.backend_managers.ToolManager
matplotlib.backend_tools.
AxisScaleBase
(*args, **kwargs)¶Bases: matplotlib.backend_tools.ToolToggleBase
Base Tool to toggle between linear and logarithmic
disable
(event)¶enable
(event)¶trigger
(sender, event, data=None)¶matplotlib.backend_tools.
ConfigureSubplotsBase
(toolmanager, name)¶Bases: matplotlib.backend_tools.ToolBase
Base tool for the configuration of subplots
description
= 'Configure subplots'¶image
= 'subplots.png'¶matplotlib.backend_tools.
Cursors
¶Bases: object
Simple namespace for cursor reference
HAND
= 0¶MOVE
= 3¶POINTER
= 1¶SELECT_REGION
= 2¶matplotlib.backend_tools.
RubberbandBase
(toolmanager, name)¶Bases: matplotlib.backend_tools.ToolBase
Draw and remove 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)¶Call draw_rubberband
or remove_rubberband
based on data
matplotlib.backend_tools.
SaveFigureBase
(toolmanager, name)¶Bases: matplotlib.backend_tools.ToolBase
Base tool for figure saving
default_keymap
= ['s', 'ctrl+s']¶description
= 'Save the figure'¶image
= 'filesave.png'¶matplotlib.backend_tools.
SetCursorBase
(*args, **kwargs)¶Bases: matplotlib.backend_tools.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)¶Set the cursor
This method has to be implemented per backend
matplotlib.backend_tools.
ToolBack
(toolmanager, name)¶Bases: matplotlib.backend_tools.ViewsPositionsBase
Move back up the view lim stack
default_keymap
= ['left', 'c', 'backspace']¶description
= 'Back to previous view'¶image
= 'back.png'¶matplotlib.backend_tools.
ToolBase
(toolmanager, name)¶Bases: object
Base tool class
A base tool, only implements trigger
method or not method at all.
The tool is instantiated by matplotlib.backend_managers.ToolManager
Attributes
toolmanager: matplotlib.backend_managers.ToolManager |
ToolManager that controls this Tool |
figure: FigureCanvas |
Figure instance that is affected by this Tool |
name: String | Used as Id of the tool, has to be unique among tools of the same ToolManager |
default_keymap
= None¶Keymap to associate with this tool
String: List of comma separated keys that will be used to call this tool when the keypress event of self.figure.canvas is emited
description
= None¶Description of the Tool
String: If the Tool is included in the Toolbar this text is used as a Tooltip
destroy
()¶Destroy the tool
This method is called when the tool is removed by
matplotlib.backend_managers.ToolManager.remove_tool
figure
¶image
= None¶Filename of the image
String: Filename of the image to use in the toolbar. If None, the
name
is used as a label in the toolbar button
name
¶Tool Id
trigger
(sender, event, data=None)¶Called when this tool gets used
This method is called by
matplotlib.backend_managers.ToolManager.trigger_tool
Parameters: | event: `Event`
sender: object
data: object
|
---|
matplotlib.backend_tools.
ToolCursorPosition
(*args, **kwargs)¶Bases: matplotlib.backend_tools.ToolBase
Send message with the current pointer position
This tool runs in the background reporting the position of the cursor
send_message
(event)¶Bases: matplotlib.backend_tools.ToolBase
Tool to enable all axes for toolmanager interaction
Bases: matplotlib.backend_tools.ToolBase
Tool to enable a specific axes for toolmanager interaction
matplotlib.backend_tools.
ToolForward
(toolmanager, name)¶Bases: matplotlib.backend_tools.ViewsPositionsBase
Move forward in the view lim stack
default_keymap
= ['right', 'v']¶description
= 'Forward to next view'¶image
= 'forward.png'¶matplotlib.backend_tools.
ToolFullScreen
(*args, **kwargs)¶Bases: matplotlib.backend_tools.ToolToggleBase
Tool to toggle full screen
default_keymap
= ['f', 'ctrl+f']¶description
= 'Toogle Fullscreen mode'¶disable
(event)¶enable
(event)¶matplotlib.backend_tools.
ToolGrid
(*args, **kwargs)¶Bases: matplotlib.backend_tools.ToolToggleBase
Tool to toggle the grid of the figure
default_keymap
= ['g']¶description
= 'Toogle Grid'¶disable
(event)¶enable
(event)¶trigger
(sender, event, data=None)¶matplotlib.backend_tools.
ToolHome
(toolmanager, name)¶Bases: matplotlib.backend_tools.ViewsPositionsBase
Restore the original view lim
default_keymap
= ['h', 'r', 'home']¶description
= 'Reset original view'¶image
= 'home.png'¶matplotlib.backend_tools.
ToolPan
(*args)¶Bases: matplotlib.backend_tools.ZoomPanBase
Pan axes with left mouse, zoom with right
cursor
= 3¶default_keymap
= ['p']¶description
= 'Pan axes with left mouse, zoom with right'¶image
= 'move.png'¶radio_group
= 'default'¶matplotlib.backend_tools.
ToolQuit
(toolmanager, name)¶Bases: matplotlib.backend_tools.ToolBase
Tool to call the figure manager destroy method
default_keymap
= ['ctrl+w', 'cmd+w']¶description
= 'Quit the figure'¶trigger
(sender, event, data=None)¶matplotlib.backend_tools.
ToolToggleBase
(*args, **kwargs)¶Bases: matplotlib.backend_tools.ToolBase
Toggleable tool
Every time it is triggered, it switches between enable and disable
cursor
= None¶Cursor to use when the tool is active
disable
(event=None)¶Disable the toggle tool
trigger
call this method when toggled
is True.
This can happen in different circumstances
matplotlib.backend_managers.ToolManager.trigger_tool
ToolToggleBase
derived tool is triggered
(from the same ToolManager
)radio_group
= None¶Attribute to group ‘radio’ like tools (mutually exclusive)
String that identifies the group or None if not belonging to a group
toggled
¶State of the toggled tool
matplotlib.backend_tools.
ToolViewsPositions
(*args, **kwargs)¶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.
add_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
()¶push the current view limits and position onto the stack
refresh_locators
()¶Redraw the canvases, update the locators
update_view
()¶Update the viewlim and position from the view and position stack for each axes
matplotlib.backend_tools.
ToolXScale
(*args, **kwargs)¶Bases: matplotlib.backend_tools.AxisScaleBase
Tool to toggle between linear and logarithmic scales on the X axis
default_keymap
= ['k', 'L']¶description
= 'Toogle Scale X axis'¶set_scale
(ax, scale)¶matplotlib.backend_tools.
ToolYScale
(*args, **kwargs)¶Bases: matplotlib.backend_tools.AxisScaleBase
Tool to toggle between linear and logarithmic scales on the Y axis
default_keymap
= ['l']¶description
= 'Toogle Scale Y axis'¶set_scale
(ax, scale)¶matplotlib.backend_tools.
ToolZoom
(*args)¶Bases: matplotlib.backend_tools.ZoomPanBase
Zoom to rectangle
cursor
= 2¶default_keymap
= ['o']¶description
= 'Zoom to rectangle'¶image
= 'zoom_to_rect.png'¶radio_group
= 'default'¶matplotlib.backend_tools.
ViewsPositionsBase
(toolmanager, name)¶Bases: matplotlib.backend_tools.ToolBase
Base class for ToolHome
, ToolBack
and ToolForward
trigger
(sender, event, data=None)¶matplotlib.backend_tools.
ZoomPanBase
(*args)¶Bases: matplotlib.backend_tools.ToolToggleBase
Base class for ToolZoom
and ToolPan
disable
(event)¶Release the canvas and disconnect press/release events
enable
(event)¶Connect press/release events and lock the canvas
scroll_zoom
(event)¶trigger
(sender, event, data=None)¶matplotlib.backend_tools.
add_tools_to_container
(container, tools=[['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom']], ['layout', ['subplots']], ['io', ['save']]])¶Add multiple tools to the container.
Parameters: | container: Container
tools : list, optional
|
---|
matplotlib.backend_tools.
add_tools_to_manager
(toolmanager, tools={'zoom': <class 'matplotlib.backend_tools.ToolZoom'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'rubberband': 'ToolRubberband', 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'cursor': 'ToolSetCursor', 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'home': <class 'matplotlib.backend_tools.ToolHome'>, 'nav': <class 'matplotlib.backend_tools.ToolEnableNavigation'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'allnav': <class 'matplotlib.backend_tools.ToolEnableAllNavigation'>, 'subplots': 'ToolConfigureSubplots', 'save': 'ToolSaveFigure', 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>})¶Add multiple tools to ToolManager
Parameters: | toolmanager: ToolManager
tools : {str: class_like}, optional
|
---|
matplotlib.backend_tools.
default_toolbar_tools
= [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom']], ['layout', ['subplots']], ['io', ['save']]]¶Default tools in the toolbar
matplotlib.backend_tools.
default_tools
= {'zoom': <class 'matplotlib.backend_tools.ToolZoom'>, 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'>, 'rubberband': 'ToolRubberband', 'quit': <class 'matplotlib.backend_tools.ToolQuit'>, 'forward': <class 'matplotlib.backend_tools.ToolForward'>, 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'>, 'cursor': 'ToolSetCursor', 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'>, 'grid': <class 'matplotlib.backend_tools.ToolGrid'>, 'home': <class 'matplotlib.backend_tools.ToolHome'>, 'nav': <class 'matplotlib.backend_tools.ToolEnableNavigation'>, 'pan': <class 'matplotlib.backend_tools.ToolPan'>, 'allnav': <class 'matplotlib.backend_tools.ToolEnableAllNavigation'>, 'subplots': 'ToolConfigureSubplots', 'save': 'ToolSaveFigure', 'yscale': <class 'matplotlib.backend_tools.ToolYScale'>, 'xscale': <class 'matplotlib.backend_tools.ToolXScale'>, 'back': <class 'matplotlib.backend_tools.ToolBack'>}¶Default tools