matplotlib.backend_managers#

classe matplotlib.backend_managers. ToolEvent ( nome , remetente , ferramenta , dados = Nenhum ) [fonte] #

Bases:object

Evento para manipulação de ferramentas (adicionar/remover).

classe matplotlib.backend_managers. ToolManager ( figure = None ) [source] #

Bases:object

Gerenciador de ações acionadas por interações do usuário (pressionamento de tecla, cliques na barra de ferramentas, ...) em uma figura.

Atributos :
figureFigure

Figura que segura a tela.

tecla de bloqueioLockDraw

LockDrawobjeto para saber se o canvaskey_press_event está bloqueado.

bloqueio de mensagemLockDraw

LockDrawobjeto para saber se a mensagem está disponível para gravação.

propriedade active_toggle #

Ferramentas atualmente alternadas.

add_tool ( nome , ferramenta , * args , ** kwargs ) [fonte] #

Adicionar ferramenta a ToolManager.

Se for bem-sucedido, adiciona um novo evento tool_trigger_{name}onde {name}é o nome da ferramenta; o evento é acionado toda vez que a ferramenta é acionada.

Parâmetros :
nome str

O nome da ferramenta, tratado como ID, deve ser único.

tipo de ferramenta

Classe da ferramenta a ser adicionada. Uma subclasse será usada se uma foi registrada para a classe de tela atual.

Veja também

matplotlib.backend_tools.ToolBase

A classe base para ferramentas.

Notas

args e kwargs são passados ​​diretamente para o construtor de ferramentas.

tela de propriedade #

Tela gerenciada pelo FigureManager.

figura da propriedade #

Figura que segura a tela.

get_tool ( nome , warning = True ) [fonte] #

Retorna o objeto de ferramenta com o nome fornecido.

Por conveniência, isso passa objetos de ferramenta.

Parâmetros :
nome str ouToolBase

Nome da ferramenta ou a própria ferramenta.

warning bool, padrão: True

Se um aviso deve ser emitido se não existe nenhuma ferramenta com o nome fornecido.

Devoluções :
ToolBaseou nenhum

A ferramenta ou None se não existir nenhuma ferramenta com o nome dado.

get_tool_keymap ( nome ) [fonte] #

Retorna o mapa de teclas associado à ferramenta especificada.

Parâmetros :
nome str

Nome da Ferramenta.

Devoluções :
lista de str

Lista de chaves associadas à ferramenta.

message_event ( mensagem , remetente = Nenhum ) [fonte] #

Emite um ToolManagerMessageEvent.

remove_tool ( nome ) [fonte] #

Remova a ferramenta nomeada name .

Parâmetros :
nome str

Nome da ferramenta.

set_figure ( figura , update_tools = True ) [fonte] #

Vincule a figura dada às ferramentas.

Parâmetros :
figuraFigure
update_tools bool, padrão: True

Forçar ferramentas para atualizar a figura.

toolmanager_connect ( s , func ) [fonte] #

Conecte o evento com string s para func .

Parâmetros :
s str

O nome do evento. Os seguintes eventos são reconhecidos:

  • 'ferramenta_message_event'

  • 'tool_removed_event'

  • 'tool_added_event'

Para cada ferramenta adicionada, um novo evento é criado

  • 'tool_trigger_TOOLNAME', onde TOOLNAME é o id da ferramenta.

func callable

Função de retorno de chamada para o evento toolmanager com assinatura:

def func(event: ToolEvent) -> Any
Devoluções :
cid

O id de retorno de chamada para a conexão. Isso pode ser usado em toolmanager_disconnect.

toolmanager_disconnect ( cid ) [fonte] #

Desconectar id de retorno de chamada cid .

Exemplo de uso:

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)
ferramentas de propriedade #

Um nome de ferramenta de mapeamento dict -> ferramenta controlada.

trigger_tool ( name , sender = None , canvasevent = None , data = None ) [source] #

Acione uma ferramenta e emita o tool_trigger_{name}evento.

Parâmetros :
nome str

Nome da ferramenta.

objeto remetente

Objeto que deseja acionar a ferramenta.

canvasevento Evento

Evento Canvas original ou Nenhum.

objeto de dados

Dados extras para passar para a ferramenta ao acionar.

update_keymap ( nome , chave ) [fonte] #

Defina o mapa de teclas para associar à ferramenta especificada.

Parâmetros :
nome str

Nome da Ferramenta.

chave str ou lista de str

Teclas a associar à ferramenta.

classe matplotlib.backend_managers. ToolManagerMessageEvent ( nome , remetente , mensagem ) [fonte] #

Bases:object

Evento carregando mensagens do gerenciador de ferramentas.

As mensagens geralmente são exibidas ao usuário pela barra de ferramentas.

classe matplotlib.backend_managers. ToolTriggerEvent ( name , sender , tool , canvasevent = None , data = None ) [source] #

Bases:ToolEvent

Evento para informar que uma ferramenta foi acionada.