はじめに
このチュートリアルでは、matplotlib.backend_managers.ToolManager を使用してツールバーを変更し、ツールを作成、追加、削除する方法を示します。
VM のヒント
VM の起動が完了したら、左上隅をクリックして ノートブック タブに切り替え、Jupyter Notebook を使用して練習します。
場合によっては、Jupyter Notebook の読み込みが完了するまで数秒待つ必要があります。Jupyter Notebook の制限により、操作の検証を自動化することはできません。
学習中に問題が発生した場合は、Labby にお問い合わせください。セッション後にフィードバックを提供してください。そうすれば、迅速に問題を解決します。
ToolManager によって制御されるすべてのツールを一覧表示する
最初のステップは、ToolManager によって制御されるすべてのツールを一覧表示することです。これは、ListTools という名前のカスタム ツールを作成することで達成できます。ListTools クラスは ToolBase から継承されています。ListTools の trigger() メソッドは、すべての利用可能なツールの名前、説明、キーマップを表示します。
class ListTools(ToolBase):
"""List all the tools controlled by the `ToolManager`."""
default_keymap = 'm' ## keyboard shortcut
description = 'List Tools'
def trigger(self, *args, **kwargs):
print('_' * 80)
fmt_tool = "{:12} {:45} {}".format
print(fmt_tool('Name (id)', 'Tool description', 'Keymap'))
print('-' * 80)
tools = self.toolmanager.tools
for name in sorted(tools):
if not tools[name].description:
continue
keys = ', '.join(sorted(self.toolmanager.get_tool_keymap(name)))
print(fmt_tool(name, tools[name].description, keys))
print('_' * 80)
fmt_active_toggle = "{!s:12} {!s:45}".format
print("Active Toggle tools")
print(fmt_active_toggle("Group", "Active"))
print('-' * 80)
for group, active in self.toolmanager.active_toggle.items():
print(fmt_active_toggle(group, active))
特定の gid を持つ線を表示する
2 番目のステップは、GroupHideTool という名前のカスタム ツールを作成することです。GroupHideTool クラスは ToolToggleBase から継承されています。GroupHideTool の set_lines_visibility() メソッドは、指定された gid を持つプロット上のすべての線の表示を、ツールが有効または無効になっているかどうかに応じて True または False に設定します。
class GroupHideTool(ToolToggleBase):
"""Show lines with a given gid."""
default_keymap = 'S'
description = 'Show by gid'
default_toggled = True
def __init__(self, *args, gid, **kwargs):
self.gid = gid
super().__init__(*args, **kwargs)
def enable(self, *args):
self.set_lines_visibility(True)
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()
カスタム ツールを追加する
3 番目のステップは、手順 1 と 2 で作成したカスタム ツールを追加することです。これは、ToolManager の add_tool() メソッドを呼び出すことで達成できます。ToolManager に ListTools と GroupHideTool のツールを追加します。また、Toolbar の add_tool() メソッドを使用して作成した Toolbar に Show ツールも追加します。
fig.canvas.manager.toolmanager.add_tool('List', ListTools)
fig.canvas.manager.toolmanager.add_tool('Show', GroupHideTool, gid='mygroup')
fig.canvas.manager.toolbar.add_tool('Show', 'navigation', 1)
ツールを削除する
4 番目のステップは、Toolbar から forward ボタンを削除することです。これは、ToolManager の remove_tool() メソッドを呼び出すことで達成できます。
fig.canvas.manager.toolmanager.remove_tool('forward')
まとめ
このチュートリアルでは、matplotlib.backend_managers.ToolManager を使用して Toolbar を変更し、カスタム ツールを作成し、ツールを追加し、削除する方法を学びました。ToolManager によって制御されるすべてのツールを一覧表示する ListTools という名前のカスタム ツールを作成しました。また、指定された gid を持つプロット上のすべての線の表示を、ツールが有効または無効になっているかどうかに応じて True または False に設定する GroupHideTool という名前のカスタム ツールも作成しました。最後に、カスタム ツールを ToolManager に追加し、Toolbar に Show ツールを追加し、Toolbar から forward ボタンを削除しました。