python matplotlib工具欄源碼探析三之添加、刪除自定義工具項(xiàng)的案例詳解

import matplotlib.pyplot as plt
# 設(shè)置工具欄使用工具欄管理器模式
plt.rcParams['toolbar'] = 'toolmanager'
# 導(dǎo)入工具項(xiàng)的基類ToolBase和ToolToggleBase
from matplotlib.backend_tools import ToolBase, ToolToggleBase

# 因?yàn)楣ぞ唔?xiàng)必須以類的形式添加，所以創(chuàng)建自定義基本工具項(xiàng)類，基類為T(mén)oolBase
class ListTools(ToolBase):
 # 該工具項(xiàng)的功能為列出工具欄管理器管理的所有工具項(xiàng)
 """List all the tools controlled by the `ToolManager`."""
 # 設(shè)置默認(rèn)快捷鍵和工具項(xiàng)描述
 default_keymap = 'm'
 description = 'List Tools'
 
 # 定義工具項(xiàng)被觸發(fā)時(shí)的動(dòng)作
 def trigger(self, *args, **kwargs):
  print('_' * 80)
  print("{0:12} {1:45} {2}".format(
   'Name (id)', 'Tool description', 'Keymap'))
  print('-' * 80)
  # 獲取工具欄管理器管理的所有工具項(xiàng)
  tools = self.toolmanager.tools
  # 輸出各個(gè)工具項(xiàng)
  for name in sorted(tools):
   if not tools[name].description:
    continue
   keys = ', '.join(sorted(self.toolmanager.get_tool_keymap(name)))
   print("{0:12} {1:45} {2}".format(
    name, tools[name].description, keys))
  print('_' * 80)
  print("Active Toggle tools")
  print("{0:12} {1:45}".format("Group", "Active"))
  print('-' * 80)
  for group, active in self.toolmanager.active_toggle.items():
   print("{0:12} {1:45}".format(str(group), str(active)))

# 基于ToolToggleBase創(chuàng)建自定義切換式工具項(xiàng)，切換式工具項(xiàng)在觸發(fā)時(shí)會(huì)在生效和失效兩種狀態(tài)之間切換
class GroupHideTool(ToolToggleBase):
 # 該工具項(xiàng)的功能為根據(jù)分組切換顯示/隱藏?cái)?shù)據(jù)元素
 """Show lines with a given gid."""
 # 設(shè)置默認(rèn)快捷鍵和工具項(xiàng)描述
 default_keymap = 'G'
 description = 'Show by gid'
 default_toggled = True
 
 # 構(gòu)造函數(shù)的參數(shù)gid為數(shù)據(jù)元素的分組
 def __init__(self, *args, gid, **kwargs):
  self.gid = gid
  super().__init__(*args, **kwargs)
 # 定義工具項(xiàng)生效時(shí)的方法
 def enable(self, *args):
  self.set_lines_visibility(True)
 # 定義工具項(xiàng)失效時(shí)的方法
 def disable(self, *args):
  self.set_lines_visibility(False)

 def set_lines_visibility(self, state):
  for ax in self.figure.get_axes():
   for line in ax.get_lines():
    if line.get_gid() == self.gid:
     line.set_visible(state)
  # 注意！在圖像生成之后，修改圖像中的元素必須重繪
  self.figure.canvas.draw()


fig = plt.figure()
# 注意通過(guò)gid屬性可以為數(shù)據(jù)元素分組
plt.plot([1, 2, 3], gid='mygroup')
plt.plot([2, 3, 4], gid='unknown')
plt.plot([3, 2, 1], gid='mygroup')

# 將自定義的工具項(xiàng)添加添加到工具欄管理器，格式為 工具項(xiàng)名稱 工具項(xiàng)類 其他參數(shù)
fig.canvas.manager.toolmanager.add_tool('List', ListTools)
fig.canvas.manager.toolmanager.add_tool('Show', GroupHideTool, gid='mygroup')

# 可以反復(fù)添加已存在的工具項(xiàng)
# Add an existing tool to new group `foo`.
# It can be added as many times as we want
fig.canvas.manager.toolbar.add_tool('zoom', 'foo')

# 刪除工具項(xiàng)
# Remove the forward button
fig.canvas.manager.toolmanager.remove_tool('forward')

# 新添加到工具欄管理器的工具項(xiàng)還不能直接使用，需要通過(guò)toolbar對(duì)象添加到當(dāng)前工具欄
# 如果不將自定義的工具項(xiàng)添加到工具欄管理器，直接使用toolbar對(duì)象添加則會(huì)報(bào)錯(cuò)
# 將自定義的工具項(xiàng)Show添加到內(nèi)置的navigation組的特定位置（即組內(nèi)第2個(gè)位置）
# To add a custom tool to the toolbar at specific location inside
# the navigation group
fig.canvas.manager.toolbar.add_tool('Show', 'navigation', 1)
#fig.canvas.manager.toolbar.add_tool('List', 'navigation', 2)
plt.show()

________________________________________________________________________________
Name (id) Tool description        Keymap
--------------------------------------------------------------------------------
List   List Tools         m
Show   Show by gid         G
allnav  Enable all axes toolmanager     a
back   Back to previous view       MouseButton.BACK, backspace, c, left
copy   Copy the canvas figure to clipboard   cmd+c, ctrl+c
fullscreen Toggle fullscreen mode      ctrl+f, f
grid   Toggle major grids       g
grid_minor Toggle major and minor grids
help   Print tool list, shortcuts and description f1
home   Reset original view       h, home, r
nav   Enable one axes toolmanager     1, 2, 3, 4, 5, 6, 7, 8, 9
pan   Pan axes with left mouse, zoom with right  p
quit   Quit the figure        cmd+w, ctrl+w, q
quit_all  Quit all figures
save   Save the figure        ctrl+s, s
subplots  Configure subplots
xscale  Toggle scale X axis       L, k
yscale  Toggle scale Y axis       l
zoom   Zoom to rectangle        o
________________________________________________________________________________
Active Toggle tools
Group  Active
--------------------------------------------------------------------------------
default  None
None   {'Show'}