matplotlib.github.com/3.3.4/api/backend_managers_api.html at main · matplotlib/matplotlib.github.com

History

440 lines (401 loc) · 30.5 KB

Raw

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

438

439

440

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.backend_managers — Matplotlib 3.3.4 documentation</title>

title="Search within Matplotlib 3.3.4 documentation"

href="../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.4). 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>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.3.4</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

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

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="backend_tools_api.html" title="matplotlib.backend_tools"

accesskey="N">next</a> |</li>

<a href="backend_bases_api.html" title="matplotlib.backend_bases"

accesskey="P">previous</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>

<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">matplotlib.backend_managers</code></a></li>

</ul>

</div>

<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">matplotlib.backend_bases</code></a></li>

<li>Next: <a href="backend_tools_api.html" title="next chapter"><code class="xref py py-mod docutils literal notranslate">matplotlib.backend_tools</code></a></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>

<h1><a class="reference internal" href="#module-matplotlib.backend_managers" title="matplotlib.backend_managers"><code class="xref py py-mod docutils literal notranslate">matplotlib.backend_managers</code></a><a class="headerlink" href="#module-matplotlib.backend_managers" title="Permalink to this headline">¶</a></h1>

class <code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolEvent</code>(name, sender, tool, data=None)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolEvent">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolEvent" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">object</code></a>

Event for tool manipulation (add/remove).

</dd></dl>

class <code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolManager</code>(figure=None)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager" title="Permalink to this definition">¶</a></dt>

Manager for actions triggered by user interactions (key press, toolbar

clicks, ...) on a Figure.

<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">figure</code></a><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">Figure</code></a></dt><dd>Figure that holds the canvas.

</dd>

<dt>keypresslock<a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate">LockDraw</code></a></dt><dd><a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate">LockDraw</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">canvas</code></a> key_press_event is locked.

</dd>

<dt>messagelock<a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate">LockDraw</code></a></dt><dd><a class="reference internal" href="widgets_api.html#matplotlib.widgets.LockDraw" title="matplotlib.widgets.LockDraw"><code class="xref py py-obj docutils literal notranslate">LockDraw</code></a> object to know if the message is available to write.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

property <code class="descname">active_toggle</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.active_toggle" title="Permalink to this definition">¶</a></dt>

<dd>Currently toggled tools.

</dd></dl>

<code class="descname">add_tool</code>(self, name, tool, *args, **kwargs)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.add_tool">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.add_tool" title="Permalink to this definition">¶</a></dt>

<dd>Add tool to <a class="reference internal" href="#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate">ToolManager</code></a>.

If successful, adds a new event <code class="docutils literal notranslate">tool_trigger_{name}</code> where

<code class="docutils literal notranslate">{name}</code> is the name of the tool; the event is fired every time the

tool is triggered.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>namestr</dt><dd>Name of the tool, treated as the ID, has to be unique.

</dd>

<dt>toolclass_like, i.e. str or type</dt><dd>Reference to find the class of the Tool to added.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

See also

<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">matplotlib.backend_tools.ToolBase</code></a></dt><dd>The base class for tools.</dd>

</dl>

</div>

Notes

args and kwargs get passed directly to the tools constructor.

</dd></dl>

property <code class="descname">canvas</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.canvas" title="Permalink to this definition">¶</a></dt>

<dd>Canvas managed by FigureManager.

</dd></dl>

property <code class="descname">figure</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.figure" title="Permalink to this definition">¶</a></dt>

<dd>Figure that holds the canvas.

</dd></dl>

<code class="descname">get_tool</code>(self, name, warn=True)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.get_tool">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.get_tool" title="Permalink to this definition">¶</a></dt>

<dd>Return the tool object with the given name.

For convenience, this passes tool objects through.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>namestr 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">ToolBase</code></a></dt><dd>Name of the tool, or the tool itself.

</dd>

<dt>warnbool, default: True</dt><dd>Whether a warning should be emitted it no tool with the given name

exists.

</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">ToolBase</code></a> or None</dt><dd>The tool or None if no tool with the given name exists.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_tool_keymap</code>(self, name)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.get_tool_keymap">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.get_tool_keymap" title="Permalink to this definition">¶</a></dt>

<dd>Return the keymap associated with the specified tool.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>namestr</dt><dd>Name of the Tool.

</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>List of keys associated with the tool.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">message_event</code>(self, message, sender=None)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.message_event">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.message_event" title="Permalink to this definition">¶</a></dt>

<dd>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">ToolManagerMessageEvent</code></a>.

</dd></dl>

<code class="descname">remove_tool</code>(self, name)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.remove_tool">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.remove_tool" title="Permalink to this definition">¶</a></dt>

<dd>Remove tool named name.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>namestr</dt><dd>Name of the tool.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">set_figure</code>(self, figure, update_tools=True)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.set_figure">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.set_figure" title="Permalink to this definition">¶</a></dt>

<dd>Bind the given figure to the tools.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>figure<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">Figure</code></a></dt><dd></dd>

<dt>update_toolsbool, default: True</dt><dd>Force tools to update figure.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">toolmanager_connect</code>(self, s, func)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.toolmanager_connect">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.toolmanager_connect" title="Permalink to this definition">¶</a></dt>

<dd>Connect event with string s to func.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>sstr</dt><dd>The name of the event. The following events are recognized:

<li>'tool_message_event'</li>

<li>'tool_removed_event'</li>

<li>'tool_added_event'</li>

</ul>

For every tool added a new event is created

<li>'tool_trigger_TOOLNAME', where TOOLNAME is the id of the tool.</li>

</ul>

</dd>

<dt>funccallable</dt><dd>Callback function for the toolmanager event with signature:

<div class="highlight-default notranslate"><div class="highlight"><pre>def func(event: ToolEvent) -> Any

</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>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">toolmanager_disconnect</code></a>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">toolmanager_disconnect</code>(self, cid)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.toolmanager_disconnect">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.toolmanager_disconnect" title="Permalink to this definition">¶</a></dt>

<dd>Disconnect callback id cid.

Example usage:

<div class="highlight-default notranslate"><div class="highlight"><pre>cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)

#...later

toolmanager.toolmanager_disconnect(cid)

</pre></div>

</div>

</dd></dl>

property <code class="descname">tools</code><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.tools" title="Permalink to this definition">¶</a></dt>

<dd>A dict mapping tool name -> controlled tool.

</dd></dl>

<code class="descname">trigger_tool</code>(self, name, sender=None, canvasevent=None, data=None)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.trigger_tool">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.trigger_tool" title="Permalink to this definition">¶</a></dt>

<dd>Trigger a tool and emit the <code class="docutils literal notranslate">tool_trigger_{name}</code> event.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>namestr</dt><dd>Name of the tool.

</dd>

<dt>senderobject</dt><dd>Object that wishes to trigger the tool.

</dd>

<dt>canvaseventEvent</dt><dd>Original Canvas event or None.

</dd>

<dt>dataobject</dt><dd>Extra data to pass to the tool when triggering.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">update_keymap</code>(self, name, key, *args)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManager.update_keymap">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManager.update_keymap" title="Permalink to this definition">¶</a></dt>

<dd>Set the keymap to associate with the specified tool.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>namestr</dt><dd>Name of the Tool.

</dd>

<dt>keysstr or list of str</dt><dd>Keys to associate with the tool.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolManagerMessageEvent</code>(name, sender, message)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolManagerMessageEvent">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolManagerMessageEvent" title="Permalink to this definition">¶</a></dt>

Event carrying messages from toolmanager.

Messages usually get displayed to the user by the toolbar.

</dd></dl>

class <code class="descclassname">matplotlib.backend_managers.</code><code class="descname">ToolTriggerEvent</code>(name, sender, tool, canvasevent=None, data=None)<a class="reference internal" href="../_modules/matplotlib/backend_managers.html#ToolTriggerEvent">[source]</a><a class="headerlink" href="#matplotlib.backend_managers.ToolTriggerEvent" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.backend_managers.ToolEvent" title="matplotlib.backend_managers.ToolEvent"><code class="xref py py-class docutils literal notranslate">matplotlib.backend_managers.ToolEvent</code></a>

Event to inform that a tool has been triggered.

</dd></dl>

</div>

</div>

Last updated on Jan 28, 2021.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.

Doc version v3.3.4.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

backend_managers_api.html

Latest commit

History

backend_managers_api.html

File metadata and controls