python matplotlib工具栏源码探析二之添加、删除内置工具项的案例


Posted in Python onFebruary 25, 2021

从matplotlib工具栏源码探析一(禁用工具栏、默认工具栏和工具栏管理器三种模式的差异)一文可知matplotlib内置实现了多个工具项的实现,而默认工具栏中的工具项只是其中的一部分,有没有方法直接管理工具栏,添加、删除内置工具项?

matplotlib内置的工具项

由源码可知,matplotlib.backend_tools.default_tools变量为字典类型,实例化了基于matplotlib.backend_tools.ToolBase类定义的内置工具项。

源码

default_tools = {'home': ToolHome, 'back': ToolBack, 'forward': ToolForward,
     'zoom': ToolZoom, 'pan': ToolPan,
     'subplots': 'ToolConfigureSubplots',
     'save': 'ToolSaveFigure',
     'grid': ToolGrid,
     'grid_minor': ToolMinorGrid,
     'fullscreen': ToolFullScreen,
     'quit': ToolQuit,
     'quit_all': ToolQuitAll,
     'allnav': _ToolEnableAllNavigation,
     'nav': _ToolEnableNavigation,
     'xscale': ToolXScale,
     'yscale': ToolYScale,
     'position': ToolCursorPosition,
     _views_positions: ToolViewsPositions,
     'cursor': 'ToolSetCursor',
     'rubberband': 'ToolRubberband',
     'help': 'ToolHelp',
     'copy': 'ToolCopyToClipboard',
     }

验证

import matplotlib.pyplot as plt
import matplotlib as mpl
from pprint import pprint

plt.rcParams['toolbar'] = 'toolmanager'
fig = plt.gcf()
pprint(mpl.backend_tools.default_tools)

输出

{'allnav': <class 'matplotlib.backend_tools._ToolEnableAllNavigation'>,
 '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'>,
 'nav': <class 'matplotlib.backend_tools._ToolEnableNavigation'>,
 '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'>}

使用工具栏管理器管理内置工具项

由源码可知默认工具栏模式toolbar2模式没有提供添加、删除工具项的接口。因此,管理工具栏需要使用工具栏管理器模式toolmanager,与该模式相关的重要定义有:

  • matplotlib.backend_bases.ToolContainerBase(toolmanager)类:工具栏容器的基类,定义了工具栏编辑的方法。构造函数参数为toolmanager,表示工具栏容器容纳的工具栏。
  • matplotlib.backend_managers.ToolManager(figure=None)类:管理用户触发工具栏工具项按钮而产生的动作。matplotlib.backend_tools.ToolBase类:所有工具栏工具项的基类,所有工具项均由matplotlib.backend_managers.ToolManager实例化。
  • matplotlib.backend_tools.default_tools变量:字典类型,实例化基于matplotlib.backend_tools.ToolBase类定义的内置工具项。
  • matplotlib.backend_tools.default_toolbar_tools变量:嵌套列表,以类似格式[[分组1, [工具1, 工具2 ...]], [分组2, [...]]]定义工具栏布局。
  • matplotlib.backend_tools.add_tools_to_container函数:设置toolbarmanager模式默认工具栏。

使用系统函数实现添加工具项

根据源码可知,matplotlib.backend_tools.add_tools_to_container函数可以设置toolbarmanager模式默认工具栏。

案例

案例说明:为工具栏添加全屏切换工具项。

import matplotlib.pyplot as plt
import matplotlib as mpl

plt.rcParams['toolbar'] = 'toolmanager'
fig = plt.gcf()
# 通过mpl.backend_tools.add_tools_to_container函数添加工具项
mpl.backend_tools.add_tools_to_container(fig.canvas.manager.toolbar, tools=[['foo', [ 'fullscreen']]])
plt.show()

案例解析:add_tools_to_container函数有两个参数containertools,由源码可知container参数的值应为fig.canvas.manager.toolbartools参数按照[[分组1, [工具1, 工具2 ...]], [分组2, [...]]]格式取值。

python matplotlib工具栏源码探析二之添加、删除内置工具项的案例

使用工具栏管理器实现添加、删除内置工具项

根据源码可知:

添加内置工具项有两种方法

  • toolbar对象可以通过add_tool方法添加内置工具项,参数为nametoolname为工具项的名称,tool为添加的工具项对应的类或者字符串。
  • toolbar对象可以通过add_toolitem方法添加内置工具项,参数为namegrouppositionimage_filedescriptiontogglename为工具项的名称,group为工具项所在组,position为工具项在组中的位置,取值为列表索引,一般取-1即在所在组末尾追加,设置为0即在所在组的首位,image_file为工具项图像,值为字符串,description为工具项描述, toggle为是否为切换式工具项,布尔值。
  • 删除内置工具项有两种方法
  • toolbar对象可以通过remove_toolitem方法删除内置工具项,参数为name,即工具项的名称。
  • toolmanager对象可以通过remove_tool方法删除内置工具项,参数为name,即工具项的名称。

案例

案例说明:删除向前工具项,添加全屏切换工具项。

import matplotlib.pyplot as plt
import matplotlib as mpl

plt.rcParams['toolbar'] = 'toolmanager'
fig = plt.gcf()

fig.canvas.manager.toolmanager.remove_tool('forward')
fig.canvas.manager.toolbar.remove_toolitem('back')
fig.canvas.manager.toolbar.add_tool('quit', 'foo')
fig.canvas.manager.toolbar.add_toolitem('fullscreen', 'foo', -1,'fullscreen','fullscreen',False) 

plt.show()

python matplotlib工具栏源码探析二之添加、删除内置工具项的案例

总结

通过工具栏管理器添加、删除内置工具项的方法很多种,需要注意调用对象、方法、参数,阅读下面的matplotlib源码可能会有所启发。

相关源码

matplotlib.backends.backend_qt5模块

class FigureManagerQT(FigureManagerBase):
 self.toolbar = self._get_toolbar(self.canvas, self.window)

 if self.toolmanager:
  backend_tools.add_tools_to_manager(self.toolmanager)
  if self.toolbar:
   backend_tools.add_tools_to_container(self.toolbar)

 if self.toolbar:
  self.window.addToolBar(self.toolbar)
  tbs_height = self.toolbar.sizeHint().height()
 else:
  tbs_height = 0
def _get_toolbar(self, canvas, parent):
  # must be inited after the window, drawingArea and figure
  # attrs are set
  if matplotlib.rcParams['toolbar'] == 'toolbar2':
   toolbar = NavigationToolbar2QT(canvas, parent, True)
  elif matplotlib.rcParams['toolbar'] == 'toolmanager':
   toolbar = ToolbarQt(self.toolmanager, self.window)
  else:
   toolbar = None
  return toolbar
class ToolbarQt(ToolContainerBase, QtWidgets.QToolBar):
 def __init__(self, toolmanager, parent):
  ToolContainerBase.__init__(self, toolmanager)
  QtWidgets.QToolBar.__init__(self, parent)
  self.setAllowedAreas(
   QtCore.Qt.TopToolBarArea | QtCore.Qt.BottomToolBarArea)
  message_label = QtWidgets.QLabel("")
  message_label.setAlignment(
   QtCore.Qt.AlignRight | QtCore.Qt.AlignVCenter)
  message_label.setSizePolicy(
   QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Expanding,
         QtWidgets.QSizePolicy.Ignored))
  self._message_action = self.addWidget(message_label)
  self._toolitems = {}
  self._groups = {}

 def add_toolitem(
   self, name, group, position, image_file, description, toggle):

  button = QtWidgets.QToolButton(self)
  if image_file:
   button.setIcon(NavigationToolbar2QT._icon(self, image_file))
  button.setText(name)
  if description:
   button.setToolTip(description)

  def handler():
   self.trigger_tool(name)
  if toggle:
   button.setCheckable(True)
   button.toggled.connect(handler)
  else:
   button.clicked.connect(handler)

  self._toolitems.setdefault(name, [])
  self._add_to_group(group, name, button, position)
  self._toolitems[name].append((button, handler))

 def _add_to_group(self, group, name, button, position):
  gr = self._groups.get(group, [])
  if not gr:
   sep = self.insertSeparator(self._message_action)
   gr.append(sep)
  before = gr[position]
  widget = self.insertWidget(before, button)
  gr.insert(position, widget)
  self._groups[group] = gr

 def toggle_toolitem(self, name, toggled):
  if name not in self._toolitems:
   return
  for button, handler in self._toolitems[name]:
   button.toggled.disconnect(handler)
   button.setChecked(toggled)
   button.toggled.connect(handler)

 def remove_toolitem(self, name):
  for button, handler in self._toolitems[name]:
   button.setParent(None)
  del self._toolitems[name]

 def set_message(self, s):
  self.widgetForAction(self._message_action).setText(s

matplotlib.backend_tools模块

def add_tools_to_container(container, tools=default_toolbar_tools):
 """
 Add multiple tools to the container.

 Parameters
 ----------
 container : Container
  `backend_bases.ToolContainerBase` object that will get the tools added.
 tools : list, optional
  List in the form ``[[group1, [tool1, tool2 ...]], [group2, [...]]]``
  where the tools ``[tool1, tool2, ...]`` will display in group1.
  See `add_tool` for details.
 """

 for group, grouptools in tools:
  for position, tool in enumerate(grouptools):
   container.add_tool(tool, group, position)
def add_tools_to_manager(toolmanager, tools=default_tools):
 """
 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.
 """

 for name, tool in tools.items():
  toolmanager.add_tool(name, tool)

到此这篇关于python matplotlib工具栏源码探析二之添加、删除内置工具项的案例的文章就介绍到这了,更多相关python matplotlib内置工具项内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
简单介绍Python中的JSON使用
Apr 28 Python
python保存文件方法小结
Jul 27 Python
python将txt文档每行内容循环插入数据库的方法
Dec 28 Python
python使用PIL实现多张图片垂直合并
Jan 15 Python
Tensorflow分类器项目自定义数据读入的实现
Feb 05 Python
python实现扫描局域网指定网段ip的方法
Apr 16 Python
python启动应用程序和终止应用程序的方法
Jun 28 Python
python使用Pandas库提升项目的运行速度过程详解
Jul 12 Python
python Dijkstra算法实现最短路径问题的方法
Sep 19 Python
Python判断字符串是否为空和null方法实例
Apr 26 Python
MxNet预训练模型到Pytorch模型的转换方式
May 25 Python
python实现简单贪吃蛇游戏
Sep 29 Python
python matplotlib工具栏源码探析三之添加、删除自定义工具项的案例详解
Feb 25 #Python
python实现简单文件读写函数
Feb 25 #Python
python pygame 愤怒的小鸟游戏示例代码
Feb 25 #Python
python网络爬虫实现发送短信验证码的方法
Feb 25 #Python
python openpyxl模块的使用详解
Feb 25 #Python
python学习之使用Matplotlib画实时的动态折线图的示例代码
Feb 25 #Python
python如何实现递归转非递归
Feb 25 #Python
You might like
IIS下配置Php+Mysql+zend的图文教程
2006/12/08 PHP
用php实现的下载css文件中的图片的代码
2010/02/08 PHP
php检测apache mod_rewrite模块是否安装的方法
2015/03/14 PHP
php阳历转农历优化版
2016/08/08 PHP
PHP使用OB缓存实现静态化功能示例
2019/03/23 PHP
将jQuery应用于login页面的问题及解决
2009/10/17 Javascript
JS 仿腾讯发表微博的效果代码
2013/12/25 Javascript
js 验证身份证信息有效性
2014/03/28 Javascript
JavaScript数值数组排序示例分享
2014/05/27 Javascript
JavaScript基础教程之alert弹出提示框实例
2014/10/16 Javascript
jquery实现聚光灯效果的方法
2015/02/06 Javascript
JavaScript实现简单图片翻转的方法
2015/04/17 Javascript
js实现的二级横向菜单条实例
2015/08/22 Javascript
PassWord输入框代码分享
2016/06/07 Javascript
jQuery实现鼠标经过像翻页和描点链接效果
2016/08/08 Javascript
谈谈jQuery之Deferred源码剖析
2016/12/19 Javascript
微信小程序 高德地图SDK详解及简单实例(源码下载)
2017/01/11 Javascript
详解Angularjs在控制器(controller.js)中使用过滤器($filter)格式化日期/时间实例
2017/02/17 Javascript
详解React 16 中的异常处理
2017/07/28 Javascript
Three.js基础学习教程
2017/11/16 Javascript
从零开始最小实现react服务器渲染详解
2018/01/26 Javascript
解决循环中setTimeout执行顺序的问题
2018/06/20 Javascript
详解vue挂载到dom上会发生什么
2019/01/20 Javascript
[04:29]2014DOTA2国际邀请赛 主赛事第三日TOPPLAY
2014/07/21 DOTA
10种检测Python程序运行时间、CPU和内存占用的方法
2015/04/01 Python
Python实现将xml导入至excel
2015/11/20 Python
python中数据爬虫requests库使用方法详解
2018/02/11 Python
使用Python快速搭建HTTP服务和文件共享服务的实例讲解
2018/06/04 Python
对Tensorflow中的变量初始化函数详解
2018/07/27 Python
常用的HTML5列表标签
2017/06/20 HTML / CSS
一个基于canvas的移动端图片编辑器的实现
2020/10/28 HTML / CSS
中国最大的团购网站:聚划算
2016/09/21 全球购物
安全事故检讨书
2014/01/18 职场文书
无锡灵山大佛导游词
2015/02/09 职场文书
聘任证明怎么写
2015/03/02 职场文书
大学迎新生的欢迎词
2019/06/25 职场文书