doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
stop()[source]
Stop the timer. | matplotlib.backend_bases_api#matplotlib.backend_bases.TimerBase.stop |
classmatplotlib.backend_bases.ToolContainerBase(toolmanager)[source]
Bases: object Base class for all tool containers, e.g. toolbars. Attributes
toolmanagerToolManager
The tools with which this ToolContainer wants to communicate. add_tool(tool, group, position=- 1)[source]
Add a tool to this container. ... | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase |
add_tool(tool, group, position=- 1)[source]
Add a tool to this container. Parameters
tooltool_like
The tool to add, see ToolManager.get_tool.
groupstr
The name of the group to add this tool to.
positionint, default: -1
The position within the group to place this tool. | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase.add_tool |
add_toolitem(name, group, position, image, description, toggle)[source]
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). Parameters
namestr
Name of the tool to add, this gets used as the to... | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase.add_toolitem |
remove_toolitem(name)[source]
Remove a toolitem from the ToolContainer. This method must get implemented per backend. Called when ToolManager emits a tool_removed_event. Parameters
namestr
Name of the tool to remove. | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase.remove_toolitem |
set_message(s)[source]
Display a message on the toolbar. Parameters
sstr
Message text. | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase.set_message |
toggle_toolitem(name, toggled)[source]
Toggle the toolitem without firing event. Parameters
namestr
Id of the tool to toggle.
toggledbool
Whether to set this tool as toggled or not. | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase.toggle_toolitem |
trigger_tool(name)[source]
Trigger the tool. Parameters
namestr
Name (id) of the tool triggered from within the container. | matplotlib.backend_bases_api#matplotlib.backend_bases.ToolContainerBase.trigger_tool |
backend_cairo A Cairo backend for Matplotlib Author
Steve Chaplin and others This backend depends on cairocffi or pycairo. matplotlib.backends.backend_cairo.FigureCanvas[source]
alias of matplotlib.backends.backend_cairo.FigureCanvasCairo
classmatplotlib.backends.backend_cairo.FigureCanvasCairo(figure=None... | matplotlib.backend_cairo_api |
matplotlib.backend_managers classmatplotlib.backend_managers.ToolEvent(name, sender, tool, data=None)[source]
Bases: object Event for tool manipulation (add/remove).
classmatplotlib.backend_managers.ToolManager(figure=None)[source]
Bases: object Manager for actions triggered by user interactions (key press, t... | matplotlib.backend_managers_api |
classmatplotlib.backend_managers.ToolEvent(name, sender, tool, data=None)[source]
Bases: object Event for tool manipulation (add/remove). | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolEvent |
classmatplotlib.backend_managers.ToolManager(figure=None)[source]
Bases: object Manager for actions triggered by user interactions (key press, toolbar clicks, ...) on a Figure. Attributes
figureFigure
Figure that holds the canvas.
keypresslockLockDraw
LockDraw object to know if the canvas key_press_event is... | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager |
add_tool(name, tool, *args, **kwargs)[source]
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. Parameters
namestr
Name of the tool, treated as the ID, has to be unique.
toolclass_like, i.e. s... | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.add_tool |
get_tool(name, warn=True)[source]
Return the tool object with the given name. For convenience, this passes tool objects through. Parameters
namestr or ToolBase
Name of the tool, or the tool itself.
warnbool, default: True
Whether a warning should be emitted it no tool with the given name exists. Returns ... | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.get_tool |
get_tool_keymap(name)[source]
Return the keymap associated with the specified tool. Parameters
namestr
Name of the Tool. Returns
list of str
List of keys associated with the tool. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.get_tool_keymap |
message_event(message, sender=None)[source]
Emit a ToolManagerMessageEvent. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.message_event |
remove_tool(name)[source]
Remove tool named name. Parameters
namestr
Name of the tool. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.remove_tool |
set_figure(figure, update_tools=True)[source]
Bind the given figure to the tools. Parameters
figureFigure
update_toolsbool, default: True
Force tools to update figure. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.set_figure |
toolmanager_connect(s, func)[source]
Connect event with string s to func. Parameters
sstr
The name of the event. The following events are recognized: 'tool_message_event' 'tool_removed_event' 'tool_added_event' For every tool added a new event is created 'tool_trigger_TOOLNAME', where TOOLNAME is the id of t... | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.toolmanager_connect |
toolmanager_disconnect(cid)[source]
Disconnect callback id cid. Example usage: cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid) | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.toolmanager_disconnect |
trigger_tool(name, sender=None, canvasevent=None, data=None)[source]
Trigger a tool and emit the tool_trigger_{name} event. Parameters
namestr
Name of the tool.
senderobject
Object that wishes to trigger the tool.
canvaseventEvent
Original Canvas event or None.
dataobject
Extra data to pass to the t... | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.trigger_tool |
update_keymap(name, key)[source]
Set the keymap to associate with the specified tool. Parameters
namestr
Name of the Tool.
keystr or list of str
Keys to associate with the tool. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManager.update_keymap |
classmatplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)[source]
Bases: object Event carrying messages from toolmanager. Messages usually get displayed to the user by the toolbar. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolManagerMessageEvent |
classmatplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)[source]
Bases: matplotlib.backend_managers.ToolEvent Event to inform that a tool has been triggered. | matplotlib.backend_managers_api#matplotlib.backend_managers.ToolTriggerEvent |
backend_mixed classmatplotlib.backends.backend_mixed.MixedModeRenderer(figure, width, height, dpi, vector_renderer, raster_renderer_class=None, bbox_inches_restore=None)[source]
Bases: object A helper class to implement a renderer that switches between vector and raster drawing. An example may be a PDF writer, wher... | matplotlib.backend_mixed_api |
backend_nbagg Interactive figures in the IPython notebook. classmatplotlib.backends.backend_nbagg.CommSocket(manager)[source]
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 ... | matplotlib.backend_nbagg_api |
backend_pdf A PDF Matplotlib backend. Author: Jouni K Seppänen <jks@iki.fi> and others. matplotlib.backends.backend_pdf.FigureCanvas[source]
alias of matplotlib.backends.backend_pdf.FigureCanvasPdf
classmatplotlib.backends.backend_pdf.FigureCanvasPdf(figure=None)[source]
Bases: matplotlib.backend_bases.Figure... | matplotlib.backend_pdf_api |
backend_pgf matplotlib.backends.backend_pgf.FigureCanvas[source]
alias of matplotlib.backends.backend_pgf.FigureCanvasPgf
classmatplotlib.backends.backend_pgf.FigureCanvasPgf(figure=None)[source]
Bases: matplotlib.backend_bases.FigureCanvasBase draw()[source]
Render the Figure. It is important that this m... | matplotlib.backend_pgf_api |
backend_ps A PostScript backend, which can produce both PostScript .ps and .eps. matplotlib.backends.backend_ps.FigureCanvas[source]
alias of matplotlib.backends.backend_ps.FigureCanvasPS
classmatplotlib.backends.backend_ps.FigureCanvasPS(figure=None)[source]
Bases: matplotlib.backend_bases.FigureCanvasBase ... | matplotlib.backend_ps_api |
backend_svg matplotlib.backends.backend_svg.FigureCanvas[source]
alias of matplotlib.backends.backend_svg.FigureCanvasSVG
classmatplotlib.backends.backend_svg.FigureCanvasSVG(figure=None)[source]
Bases: matplotlib.backend_bases.FigureCanvasBase draw()[source]
Render the Figure. It is important that this m... | matplotlib.backend_svg_api |
backend_template A fully functional, do-nothing backend intended as a template for backend writers. It is fully functional in that you can select it as a backend e.g. with import matplotlib
matplotlib.use("template")
and your program will (should!) run without error, though no output is produced. This provides a start... | matplotlib.backend_template_api |
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.ToolMa... | matplotlib.backend_tools_api |
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 ... | matplotlib.backend_tools_api#matplotlib.backend_tools.add_tools_to_container |
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 'mat... | matplotlib.backend_tools_api#matplotlib.backend_tools.add_tools_to_manager |
classmatplotlib.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 when toggled is True. This can happen in different circumstances. Click ... | matplotlib.backend_tools_api#matplotlib.backend_tools.AxisScaleBase |
disable(event)[source]
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). | matplotlib.backend_tools_api#matplotlib.backend_tools.AxisScaleBase.disable |
enable(event)[source]
Enable the toggle tool. trigger calls this method when toggled is False. | matplotlib.backend_tools_api#matplotlib.backend_tools.AxisScaleBase.enable |
trigger(sender, event, data=None)[source]
Calls enable or disable based on toggled value. | matplotlib.backend_tools_api#matplotlib.backend_tools.AxisScaleBase.trigger |
classmatplotlib.backend_tools.ConfigureSubplotsBase(toolmanager, name)[source]
Bases: matplotlib.backend_tools.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 ... | matplotlib.backend_tools_api#matplotlib.backend_tools.ConfigureSubplotsBase |
description='Configure subplots'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ConfigureSubplotsBase.description |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.ConfigureSubplotsBase.image |
matplotlib.backend_tools.cursors[source]
alias of matplotlib.backend_tools.Cursors | matplotlib.backend_tools_api#matplotlib.backend_tools.cursors |
classmatplotlib.backend_tools.Cursors(value)[source]
Bases: enum.IntEnum Backend-independent cursor types. HAND=2[source]
MOVE=4[source]
POINTER=1[source]
RESIZE_HORIZONTAL=6[source]
RESIZE_VERTICAL=7[source]
SELECT_REGION=3[source]
WAIT=5[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors |
HAND=2[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.HAND |
MOVE=4[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.MOVE |
POINTER=1[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.POINTER |
RESIZE_HORIZONTAL=6[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.RESIZE_HORIZONTAL |
RESIZE_VERTICAL=7[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.RESIZE_VERTICAL |
SELECT_REGION=3[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.SELECT_REGION |
WAIT=5[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.Cursors.WAIT |
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_api#matplotlib.backend_tools.default_toolbar_tools |
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.Tool... | matplotlib.backend_tools_api#matplotlib.backend_tools.default_tools |
classmatplotlib.backend_tools.RubberbandBase(toolmanager, name)[source]
Bases: matplotlib.backend_tools.ToolBase Draw and remove a rubberband. draw_rubberband(*data)[source]
Draw rubberband. This method must get implemented per backend.
remove_rubberband()[source]
Remove rubberband. This method should get i... | matplotlib.backend_tools_api#matplotlib.backend_tools.RubberbandBase |
draw_rubberband(*data)[source]
Draw rubberband. This method must get implemented per backend. | matplotlib.backend_tools_api#matplotlib.backend_tools.RubberbandBase.draw_rubberband |
remove_rubberband()[source]
Remove rubberband. This method should get implemented per backend. | matplotlib.backend_tools_api#matplotlib.backend_tools.RubberbandBase.remove_rubberband |
trigger(sender, event, data)[source]
Call draw_rubberband or remove_rubberband based on data. | matplotlib.backend_tools_api#matplotlib.backend_tools.RubberbandBase.trigger |
classmatplotlib.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 on self.figure.canva... | matplotlib.backend_tools_api#matplotlib.backend_tools.SaveFigureBase |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.SaveFigureBase.default_keymap |
description='Save the figure'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.SaveFigureBase.description |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.SaveFigureBase.image |
classmatplotlib.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 calls set_cursor when a tool gets triggered. set_cursor(cursor)[source]
[Deprecated] Set the curs... | matplotlib.backend_tools_api#matplotlib.backend_tools.SetCursorBase |
set_cursor(cursor)[source]
[Deprecated] Set the cursor. Notes Deprecated since version 3.5. | matplotlib.backend_tools_api#matplotlib.backend_tools.SetCursorBase.set_cursor |
set_figure(figure)[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.SetCursorBase.set_figure |
classmatplotlib.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 keyp... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBack |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBack.default_keymap |
description='Back to previous view'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBack.description |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBack.image |
classmatplotlib.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 by matplotlib.backend_managers.ToolManager. propertycanvas
The canvas of the figure affected by this tool, or None.
default... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBase |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBase.default_keymap |
description=None
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBase.description |
destroy()[source]
Destroy the tool. This method is called by ToolManager.remove_tool. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBase.destroy |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBase.image |
set_figure(figure)[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolBase.set_figure |
trigger(sender, event, data=None)[source]
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_api#matplotlib.backend_tools.ToolBase.trigger |
matplotlib.backend_tools.ToolCopyToClipboard[source]
alias of matplotlib.backend_tools.ToolCopyToClipboardBase | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCopyToClipboard |
classmatplotlib.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 em... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCopyToClipboardBase |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCopyToClipboardBase.default_keymap |
description='Copy the canvas figure to clipboard'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCopyToClipboardBase.description |
trigger(*args, **kwargs)[source]
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_api#matplotlib.backend_tools.ToolCopyToClipboardBase.trigger |
classmatplotlib.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. send_message(event)[source]
Call matplotlib.backend_managers.ToolManager.message... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCursorPosition |
send_message(event)[source]
Call matplotlib.backend_managers.ToolManager.message_event. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCursorPosition.send_message |
set_figure(figure)[source] | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolCursorPosition.set_figure |
classmatplotlib.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 e... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolForward |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolForward.default_keymap |
description='Forward to next view'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolForward.description |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolForward.image |
classmatplotlib.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 on self.figure.ca... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolFullScreen |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolFullScreen.default_keymap |
description='Toggle fullscreen mode'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolFullScreen.description |
disable(event)[source]
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). | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolFullScreen.disable |
enable(event)[source]
Enable the toggle tool. trigger calls this method when toggled is False. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolFullScreen.enable |
classmatplotlib.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 on self.figure.canv... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolGrid |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolGrid.default_keymap |
description='Toggle major grids'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolGrid.description |
trigger(sender, event, data=None)[source]
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_api#matplotlib.backend_tools.ToolGrid.trigger |
classmatplotlib.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 on self.figure.canvas.
description='Print tool list, sho... | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolHelpBase |
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 on self.figure.canvas. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolHelpBase.default_keymap |
description='Print tool list, shortcuts and description'
Description of the Tool. str: Tooltip used if the Tool is included in a Toolbar. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolHelpBase.description |
staticformat_shortcut(key_sequence)[source]
Convert a shortcut string from the notation used in rc config to the standard notation for displaying shortcuts, e.g. 'ctrl+a' -> 'Ctrl+A'. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolHelpBase.format_shortcut |
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. | matplotlib.backend_tools_api#matplotlib.backend_tools.ToolHelpBase.image |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.