Gerenciador de Ferramentas Matplotlib

Introdução

Este tutorial mostrará como modificar a Toolbar (barra de ferramentas), criar ferramentas, adicionar ferramentas e remover ferramentas usando matplotlib.backend_managers.ToolManager.

Dicas para a VM

Após a inicialização da VM, clique no canto superior esquerdo para mudar para a aba Notebook e acessar o Jupyter Notebook para praticar.

Às vezes, pode ser necessário aguardar alguns segundos para que o Jupyter Notebook termine de carregar. A validação das operações não pode ser automatizada devido a limitações no Jupyter Notebook.

Se você enfrentar problemas durante o aprendizado, sinta-se à vontade para perguntar ao Labby. Forneça feedback após a sessão, e resolveremos o problema prontamente para você.

Listar todas as ferramentas controladas pelo ToolManager

O primeiro passo é listar todas as ferramentas controladas pelo ToolManager. Isso pode ser alcançado criando uma ferramenta personalizada chamada ListTools. A classe ListTools herda de ToolBase. O método trigger() de ListTools imprime o nome, a descrição e o keymap (mapa de teclas) de todas as ferramentas disponíveis.

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))

Mostrar linhas com um determinado gid

O segundo passo é criar uma ferramenta personalizada chamada GroupHideTool. A classe GroupHideTool herda de ToolToggleBase. O método set_lines_visibility() de GroupHideTool define a visibilidade de todas as linhas no gráfico que possuem o gid especificado como True ou False, dependendo se a ferramenta está habilitada ou desabilitada.

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()

Adicionar ferramentas personalizadas

O terceiro passo é adicionar as ferramentas personalizadas que criamos nos passos 1 e 2. Isso pode ser alcançado chamando o método add_tool() do ToolManager. Adicionamos as ferramentas ListTools e GroupHideTool ao ToolManager. Também adicionamos a ferramenta Show à Toolbar, que foi criada usando o método add_tool() da Toolbar.

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)

Remover ferramentas

O quarto passo é remover o botão forward da Toolbar. Podemos conseguir isso chamando o método remove_tool() do ToolManager.

fig.canvas.manager.toolmanager.remove_tool('forward')

Resumo

Neste tutorial, aprendemos como modificar a Toolbar, criar ferramentas personalizadas, adicionar ferramentas e remover ferramentas usando matplotlib.backend_managers.ToolManager. Criamos uma ferramenta personalizada chamada ListTools, que lista todas as ferramentas controladas pelo ToolManager. Também criamos uma ferramenta personalizada chamada GroupHideTool, que define a visibilidade de todas as linhas no gráfico que possuem o gid especificado como True ou False, dependendo se a ferramenta está habilitada ou desabilitada. Finalmente, adicionamos as ferramentas personalizadas ao ToolManager, adicionamos a ferramenta Show à Toolbar e removemos o botão forward da Toolbar.