-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathbackend_managers_api.html
More file actions
437 lines (398 loc) · 28.7 KB
/
backend_managers_api.html
File metadata and controls
437 lines (398 loc) · 28.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.backend_managers — Matplotlib 3.3.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.0-3-g8994f1b60" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.backend_tools" href="backend_tools_api.html" />
<link rel="prev" title="matplotlib.backend_bases" href="backend_bases_api.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_managers_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.0). For the latest version see <a href="https://matplotlib.org/stable/api/backend_managers_api.html">https://matplotlib.org/stable/api/backend_managers_api.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.0</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="backend_tools_api.html" title="matplotlib.backend_tools"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_bases_api.html" title="matplotlib.backend_bases"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="backend_bases_api.html" title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backend_bases</span></code></a></li>
<li>Next: <a href="backend_tools_api.html" title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backend_tools</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/backend_managers_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.backend_managers">
<span id="matplotlib-backend-managers"></span><h1><a class="reference internal" href="#module-matplotlib.backend_managers" title="matplotlib.backend_managers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backend_managers</span></code></a><a class="headerlink" href="#module-matplotlib.backend_managers" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="matplotlib.backend_managers.ToolEvent">
<em class="property">class </em><code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolEvent</code><span class="sig-paren">(</span><em>name</em>, <em>sender</em>, <em>tool</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Event for tool manipulation (add/remove).</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_managers.ToolManager">
<em class="property">class </em><code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolManager</code><span class="sig-paren">(</span><em>figure=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Manager for actions triggered by user interactions (key press, toolbar
clicks, ...) on a Figure.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference internal" href="#matplotlib.backend_managers.ToolManager.figure" title="matplotlib.backend_managers.ToolManager.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figure</span></code></a><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd><p>Figure that holds the canvas.</p>
</dd>
<dt><strong>keypresslock</strong><span class="classifier"><a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LockDraw</span></code></a></span></dt><dd><p><a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LockDraw</span></code></a> object to know if the <a class="reference internal" href="#matplotlib.backend_managers.ToolManager.canvas" title="matplotlib.backend_managers.ToolManager.canvas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">canvas</span></code></a> key_press_event is locked.</p>
</dd>
<dt><strong>messagelock</strong><span class="classifier"><a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LockDraw</span></code></a></span></dt><dd><p><a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LockDraw</span></code></a> object to know if the message is available to write.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.active_toggle">
<em class="property">property </em><code class="descname">active_toggle</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.active_toggle" title="Permalink to this definition">¶</a></dt>
<dd><p>Currently toggled tools.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.add_tool">
<code class="descname">add_tool</code><span class="sig-paren">(</span><em>self</em>, <em>name</em>, <em>tool</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.add_tool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.add_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Add <em>tool</em> to <a class="reference internal" href="#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolManager</span></code></a>.</p>
<p>If successful, adds a new event <code class="docutils literal notranslate"><span class="pre">tool_trigger_{name}</span></code> where
<code class="docutils literal notranslate"><span class="pre">{name}</span></code> is the <em>name</em> of the tool; the event is fired every time the
tool is triggered.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>Name of the tool, treated as the ID, has to be unique.</p>
</dd>
<dt><strong>tool</strong><span class="classifier">class_like, i.e. str or type</span></dt><dd><p>Reference to find the class of the Tool to added.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="backend_tools_api.html#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></dt><dd>The base class for tools.</dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>args and kwargs get passed directly to the tools constructor.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.canvas">
<em class="property">property </em><code class="descname">canvas</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.canvas" title="Permalink to this definition">¶</a></dt>
<dd><p>Canvas managed by FigureManager.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.figure">
<em class="property">property </em><code class="descname">figure</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Figure that holds the canvas.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.get_tool">
<code class="descname">get_tool</code><span class="sig-paren">(</span><em>self</em>, <em>name</em>, <em>warn=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.get_tool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.get_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tool object with the given name.</p>
<p>For convenience, this passes tool objects through.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>name</strong><span class="classifier">str or <a class="reference internal" href="backend_tools_api.html#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolBase</span></code></a></span></dt><dd><p>Name of the tool, or the tool itself.</p>
</dd>
<dt><strong>warn</strong><span class="classifier">bool, default: True</span></dt><dd><p>Whether a warning should be emitted it no tool with the given name
exists.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference internal" href="backend_tools_api.html#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolBase</span></code></a> or None</dt><dd><p>The tool or None if no tool with the given name exists.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.get_tool_keymap">
<code class="descname">get_tool_keymap</code><span class="sig-paren">(</span><em>self</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.get_tool_keymap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.get_tool_keymap" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the keymap associated with the specified tool.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>Name of the Tool.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>list of str</dt><dd><p>List of keys associated with the tool.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.message_event">
<code class="descname">message_event</code><span class="sig-paren">(</span><em>self</em>, <em>message</em>, <em>sender=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.message_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.message_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Emit a <a class="reference internal" href="#matplotlib.backend_managers.ToolManagerMessageEvent" title="matplotlib.backend_managers.ToolManagerMessageEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolManagerMessageEvent</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.remove_tool">
<code class="descname">remove_tool</code><span class="sig-paren">(</span><em>self</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.remove_tool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.remove_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove tool named <em>name</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>Name of the tool.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em>self</em>, <em>figure</em>, <em>update_tools=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Bind the given figure to the tools.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>figure</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd></dd>
<dt><strong>update_tools</strong><span class="classifier">bool, default: True</span></dt><dd><p>Force tools to update figure.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.toolmanager_connect">
<code class="descname">toolmanager_connect</code><span class="sig-paren">(</span><em>self</em>, <em>s</em>, <em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.toolmanager_connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.toolmanager_connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect event with string <em>s</em> to <em>func</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>s</strong><span class="classifier">str</span></dt><dd><p>The name of the event. The following events are recognized:</p>
<ul class="simple">
<li>'tool_message_event'</li>
<li>'tool_removed_event'</li>
<li>'tool_added_event'</li>
</ul>
<p>For every tool added a new event is created</p>
<ul class="simple">
<li>'tool_trigger_TOOLNAME', where TOOLNAME is the id of the tool.</li>
</ul>
</dd>
<dt><strong>func</strong><span class="classifier">callable</span></dt><dd><p>Callback function for the toolmanager event with signature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">event</span><span class="p">:</span> <span class="n">ToolEvent</span><span class="p">)</span> <span class="o">-></span> <span class="n">Any</span>
</pre></div>
</div>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>cid</dt><dd><p>The callback id for the connection. This can be used in
<a class="reference internal" href="#matplotlib.backend_managers.ToolManager.toolmanager_disconnect" title="matplotlib.backend_managers.ToolManager.toolmanager_disconnect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toolmanager_disconnect</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.toolmanager_disconnect">
<code class="descname">toolmanager_disconnect</code><span class="sig-paren">(</span><em>self</em>, <em>cid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.toolmanager_disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.toolmanager_disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect callback id <em>cid</em>.</p>
<p>Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cid</span> <span class="o">=</span> <span class="n">toolmanager</span><span class="o">.</span><span class="n">toolmanager_connect</span><span class="p">(</span><span class="s1">'tool_trigger_zoom'</span><span class="p">,</span> <span class="n">onpress</span><span class="p">)</span>
<span class="c1">#...later</span>
<span class="n">toolmanager</span><span class="o">.</span><span class="n">toolmanager_disconnect</span><span class="p">(</span><span class="n">cid</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.tools">
<em class="property">property </em><code class="descname">tools</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.tools" title="Permalink to this definition">¶</a></dt>
<dd><p>A dict mapping tool name -> controlled tool.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.trigger_tool">
<code class="descname">trigger_tool</code><span class="sig-paren">(</span><em>self</em>, <em>name</em>, <em>sender=None</em>, <em>canvasevent=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.trigger_tool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.trigger_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Trigger a tool and emit the <code class="docutils literal notranslate"><span class="pre">tool_trigger_{name}</span></code> event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>Name of the tool.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that wishes to trigger the tool.</p>
</dd>
<dt><strong>canvasevent</strong><span class="classifier">Event</span></dt><dd><p>Original Canvas event or None.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data to pass to the tool when triggering.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_managers.ToolManager.update_keymap">
<code class="descname">update_keymap</code><span class="sig-paren">(</span><em>self</em>, <em>name</em>, <em>key</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.update_keymap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.update_keymap" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the keymap to associate with the specified tool.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>name</strong><span class="classifier">str</span></dt><dd><p>Name of the Tool.</p>
</dd>
<dt><strong>keys</strong><span class="classifier">str or list of str</span></dt><dd><p>Keys to associate with the tool.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_managers.ToolManagerMessageEvent">
<em class="property">class </em><code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolManagerMessageEvent</code><span class="sig-paren">(</span><em>name</em>, <em>sender</em>, <em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManagerMessageEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolManagerMessageEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Event carrying messages from toolmanager.</p>
<p>Messages usually get displayed to the user by the toolbar.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_managers.ToolTriggerEvent">
<em class="property">class </em><code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolTriggerEvent</code><span class="sig-paren">(</span><em>name</em>, <em>sender</em>, <em>tool</em>, <em>canvasevent=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolTriggerEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_managers.ToolTriggerEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_managers.ToolEvent" title="matplotlib.backend_managers.ToolEvent"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolEvent</span></code></a></p>
<p>Event to inform that a tool has been triggered.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Jul 17, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
Doc version v3.3.0-3-g8994f1b60.
</div>
</footer>
</body>
</html>