Add toolbar button icon matplotlib

Question

I want to add an icon to a custom button in a matplotlib figure toolbar. How can I do that? So far, I have the following code:

import matplotlib
matplotlib.rcParams["toolbar"] = "toolmanager"
import matplotlib.pyplot as plt
from matplotlib.backend_tools import ToolToggleBase

class NewTool(ToolToggleBase):
    ...[tool code]

fig = plt.figure()
ax = fig.add_subplot(111)
ax.plot([1, 2, 3], label="legend")
ax.legend()
fig.canvas.manager.toolmanager.add_tool("newtool", NewTool)
fig.canvas.manager.toolbar.add_tool(toolmanager.get_tool("newtool"), "toolgroup")
fig.show()

For now, the only thing that it does is adding a new button (which do what I want) but the icon is only the tool's name i.e.: "newtool". How can I change this for a custom icon like a png image?

ImportanceOfBeingErnest · Accepted Answer · 2018-10-24 15:10:18Z

9

The tool can have an attribute image, which denotes the path to a png image.

import matplotlib
matplotlib.rcParams["toolbar"] = "toolmanager"
import matplotlib.pyplot as plt
from matplotlib.backend_tools import ToolBase

class NewTool(ToolBase):
    image = r"C:\path\to\hiker.png"

fig = plt.figure()
ax = fig.add_subplot(111)
ax.plot([1, 2, 3], label="legend")
ax.legend()
tm = fig.canvas.manager.toolmanager
tm.add_tool("newtool", NewTool)
fig.canvas.manager.toolbar.add_tool(tm.get_tool("newtool"), "toolgroup")
plt.show()

answered Oct 24, 2018 at 15:10

ImportanceOfBeingErnest

342k61 gold badges737 silver badges771 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

bad_locality Over a year ago

I tried this solution, there is also a similar solution on matplotlib docs, but I cannot reproduce it. I get the following error: tm.add_tool("newtool", NewTool) AttributeError: 'NoneType' object has no attribute 'add_tool' Seems weird that plt.figure() does not contain canvas. Any ideas?

Theom Over a year ago

I get the same AttributeError in Jupyter but it works fine within a standard IDE (even though I use the same interpreter in both). It looks like it has to do with the choice of backend.

sdbbs Over a year ago

Since this was the first page I stumbled upon in my searches, and I also wanted to know about Matplotlib in Jupyter, here is a Gihub issue where it is discussed: Make the toolbar customizable · Issue #270 · matplotlib/ipympl · GitHub

fgoudra Over a year ago

@bad_locality I believe you get this error if you do not use the rc option matplotlib.rcParams["toolbar"] = "toolmanager"

Benoïd Kauppias · Accepted Answer · 2022-12-03 22:11:04Z

1

I tried this solution, there is also a similar solution on matplotlib docs, but I >cannot reproduce it. I get the following error: tm.add_tool("newtool", NewTool) >AttributeError: 'NoneType' object has no attribute 'add_tool' Seems weird that >plt.figure() does not contain canvas. Any ideas? – bad_locality Jun 25, 2020 at 12:12

I do not know if it's help, but I had the same issues at first and then i realized that I had not activated the interactive matplotlib option (%matplotlib with Python - spyder). Therefore no toolbar are associated since it only create a static figure.

answered Dec 3, 2022 at 22:11

Benoïd Kauppias

111 bronze badge

1 Comment

Piezoid Over a year ago

This does not provide an answer to the question. Once you have sufficient reputation you will be able to comment on any post; instead, provide answers that don't require clarification from the asker. - From Review

Collectives™ on Stack Overflow

Add toolbar button icon matplotlib

2 Answers 2

4 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related