-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_template_api.html
More file actions
446 lines (403 loc) · 38 KB
/
backend_template_api.html
File metadata and controls
446 lines (403 loc) · 38 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
438
439
440
441
442
443
444
445
446
<!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" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>matplotlib.backends.backend_template — Matplotlib 3.4.3 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/mpl.css?v3.4.3-2-ge48e4acce0" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.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" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.3 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.backends.backend_agg" href="backend_agg_api.html" />
<link rel="prev" title="matplotlib.backends.backend_mixed" href="backend_mixed_api.html" />
<link rel="top" title="Matplotlib 3.4.3 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_template_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.4.3). For the latest version see <a href="https://matplotlib.org/stable/api/backend_template_api.html">https://matplotlib.org/stable/api/backend_template_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.4.3</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
</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_agg_api.html" title="matplotlib.backends.backend_agg"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_mixed_api.html" title="matplotlib.backends.backend_mixed"
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" >API Overview</a> »</li>
<li class="nav-item nav-item-2"><a href="index_backend_api.html" accesskey="U"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_template</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<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_template_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.backends.backend_template">
<span id="matplotlib-backends-backend-template"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_template" title="matplotlib.backends.backend_template"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_template</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_template" title="Permalink to this headline">¶</a></h1>
<p>A fully functional, do-nothing backend intended as a template for backend
writers. It is fully functional in that you can select it as a backend e.g.
with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s2">"template"</span><span class="p">)</span>
</pre></div>
</div>
<p>and your program will (should!) run without error, though no output is
produced. This provides a starting point for backend writers; you can
selectively implement drawing methods (<a class="reference internal" href="#matplotlib.backends.backend_template.RendererTemplate.draw_path" title="matplotlib.backends.backend_template.RendererTemplate.draw_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_path</span></code></a>,
<a class="reference internal" href="#matplotlib.backends.backend_template.RendererTemplate.draw_image" title="matplotlib.backends.backend_template.RendererTemplate.draw_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_image</span></code></a>, etc.) and slowly see your figure come to life
instead having to have a full blown implementation before getting any results.</p>
<p>Copy this file to a directory outside of the Matplotlib source tree, somewhere
where Python can import it (by adding the directory to your <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> or by
packaging it as a normal Python package); if the backend is importable as
<code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">my.backend</span></code> you can then select it using</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s2">"module://my.backend"</span><span class="p">)</span>
</pre></div>
</div>
<p>If your backend implements support for saving figures (i.e. has a <code class="xref py py-obj docutils literal notranslate"><span class="pre">print_xyz</span></code>
method), you can register it as the default handler for a given file type:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.backend_bases</span> <span class="kn">import</span> <span class="n">register_backend</span>
<span class="n">register_backend</span><span class="p">(</span><span class="s1">'xyz'</span><span class="p">,</span> <span class="s1">'my_backend'</span><span class="p">,</span> <span class="s1">'XYZ File Format'</span><span class="p">)</span>
<span class="o">...</span>
<span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="s2">"figure.xyz"</span><span class="p">)</span>
</pre></div>
</div>
<dl class="py attribute">
<dt id="matplotlib.backends.backend_template.FigureCanvas">
<code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">FigureCanvas</code><a class="headerlink" href="#matplotlib.backends.backend_template.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_template.FigureCanvasTemplate" title="matplotlib.backends.backend_template.FigureCanvasTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_template.FigureCanvasTemplate</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_template.FigureCanvasTemplate">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">FigureCanvasTemplate</code><span class="sig-paren">(</span><em><span class="n">figure</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#FigureCanvasTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.FigureCanvasTemplate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase" title="matplotlib.backend_bases.FigureCanvasBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.FigureCanvasBase</span></code></a></p>
<p>The canvas the figure renders into. Calls the draw and print fig
methods, creates the renderers, etc.</p>
<p>Note: GUI templates will want to connect events for button presses,
mouse movements and key presses to functions that call the base
class methods button_press_event, button_release_event,
motion_notify_event, key_press_event, and key_release_event. See the
implementations of the interactive backends for examples.</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><strong>figure</strong><span class="classifier"><a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.figure.Figure</span></code></a></span></dt><dd><p>A high-level Figure instance</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.FigureCanvasTemplate.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#FigureCanvasTemplate.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.FigureCanvasTemplate.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the figure using the renderer.</p>
<p>It is important that this method actually walk the artist tree
even if not output is produced because this will trigger
deferred work (like computing limits auto-limits and tick
values) that users may want access to before saving to disk.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backends.backend_template.FigureCanvasTemplate.filetypes">
<code class="descname">filetypes</code><em class="property"> = {'eps': 'Encapsulated Postscript', 'foo': 'My magic Foo format', 'jpeg': 'Joint Photographic Experts Group', 'jpg': 'Joint Photographic Experts Group', 'pdf': 'Portable Document Format', 'pgf': 'PGF code for LaTeX', 'png': 'Portable Network Graphics', 'ps': 'Postscript', 'raw': 'Raw RGBA bitmap', 'rgba': 'Raw RGBA bitmap', 'svg': 'Scalable Vector Graphics', 'svgz': 'Scalable Vector Graphics', 'tif': 'Tagged Image File Format', 'tiff': 'Tagged Image File Format'}</em><a class="headerlink" href="#matplotlib.backends.backend_template.FigureCanvasTemplate.filetypes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.FigureCanvasTemplate.get_default_filetype">
<code class="descname">get_default_filetype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#FigureCanvasTemplate.get_default_filetype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.FigureCanvasTemplate.get_default_filetype" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the default savefig file format as specified in
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=savefig.format#a-sample-matplotlibrc-file"><span class="pre">rcParams["savefig.format"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'png'</span></code>).</p>
<p>The returned string does not include a period. This method is
overridden in backends that only support a single file type.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.FigureCanvasTemplate.print_foo">
<code class="descname">print_foo</code><span class="sig-paren">(</span><em><span class="n">filename</span></em>, <em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#FigureCanvasTemplate.print_foo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.FigureCanvasTemplate.print_foo" title="Permalink to this definition">¶</a></dt>
<dd><p>Write out format foo.</p>
<p>This method is normally called via <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.savefig</span></code></a> and
<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase.print_figure" title="matplotlib.backend_bases.FigureCanvasBase.print_figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FigureCanvasBase.print_figure</span></code></a>, which take care of setting the figure
facecolor, edgecolor, and dpi to the desired output values, and will
restore them to the original values. Therefore, <a class="reference internal" href="#matplotlib.backends.backend_template.FigureCanvasTemplate.print_foo" title="matplotlib.backends.backend_template.FigureCanvasTemplate.print_foo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_foo</span></code></a> does not
need to handle these settings.</p>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backends.backend_template.FigureManager">
<code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">FigureManager</code><a class="headerlink" href="#matplotlib.backends.backend_template.FigureManager" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_template.FigureManagerTemplate" title="matplotlib.backends.backend_template.FigureManagerTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_template.FigureManagerTemplate</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_template.FigureManagerTemplate">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">FigureManagerTemplate</code><span class="sig-paren">(</span><em><span class="n">canvas</span></em>, <em><span class="n">num</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#FigureManagerTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.FigureManagerTemplate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureManagerBase" title="matplotlib.backend_bases.FigureManagerBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.FigureManagerBase</span></code></a></p>
<p>Helper class for pyplot mode, wraps everything up into a neat bundle.</p>
<p>For non-interactive backends, the base class is sufficient.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_template.GraphicsContextTemplate">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">GraphicsContextTemplate</code><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#GraphicsContextTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.GraphicsContextTemplate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.GraphicsContextBase</span></code></a></p>
<p>The graphics context provides the color, line styles, etc... See the cairo
and postscript backends for examples of mapping the graphics context
attributes (cap styles, join styles, line widths, colors) to a particular
backend. In cairo this is done by wrapping a cairo.Context object and
forwarding the appropriate calls to it using a dictionary mapping styles
to gdk constants. In Postscript, all the work is done by the renderer,
mapping line styles to postscript calls.</p>
<p>If it's more appropriate to do the mapping at the renderer level (as in
the postscript backend), you don't need to override any of the GC methods.
If it's more appropriate to wrap an instance (as in the cairo backend) and
do the mapping here, you'll need to override several of the setter
methods.</p>
<p>The base GraphicsContext stores colors as a RGB tuple on the unit
interval, e.g., (0.5, 0.0, 1.0). You may need to map this to colors
appropriate for your backend.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_template.RendererTemplate">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">RendererTemplate</code><span class="sig-paren">(</span><em><span class="n">dpi</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a></p>
<p>The renderer handles drawing/rendering operations.</p>
<p>This is a minimal do-nothing class that can be used to get started when
writing a new backend. Refer to <code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_bases.RendererBase</span></code> for
documentation of the methods.</p>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.draw_image">
<code class="descname">draw_image</code><span class="sig-paren">(</span><em><span class="n">gc</span></em>, <em><span class="n">x</span></em>, <em><span class="n">y</span></em>, <em><span class="n">im</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.draw_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.draw_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw an RGBA image.</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>gc</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></a></span></dt><dd><p>A graphics context with clipping information.</p>
</dd>
<dt><strong>x</strong><span class="classifier">scalar</span></dt><dd><p>The distance in physical units (i.e., dots or pixels) from the left
hand side of the canvas.</p>
</dd>
<dt><strong>y</strong><span class="classifier">scalar</span></dt><dd><p>The distance in physical units (i.e., dots or pixels) from the
bottom side of the canvas.</p>
</dd>
<dt><strong>im</strong><span class="classifier">(N, M, 4) array-like of np.uint8</span></dt><dd><p>An array of RGBA pixels.</p>
</dd>
<dt><strong>transform</strong><span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Affine2DBase</span></code></a></span></dt><dd><p>If and only if the concrete backend is written such that
<code class="xref py py-meth docutils literal notranslate"><span class="pre">option_scale_image()</span></code> returns <code class="docutils literal notranslate"><span class="pre">True</span></code>, an affine
transformation (i.e., an <a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Affine2DBase</span></code></a>) <em>may</em> be passed to
<a class="reference internal" href="#matplotlib.backends.backend_template.RendererTemplate.draw_image" title="matplotlib.backends.backend_template.RendererTemplate.draw_image"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_image()</span></code></a>. The translation vector of the transformation
is given in physical units (i.e., dots or pixels). Note that
the transformation does not override <em>x</em> and <em>y</em>, and has to be
applied <em>before</em> translating the result by <em>x</em> and <em>y</em> (this can
be accomplished by adding <em>x</em> and <em>y</em> to the translation vector
defined by <em>transform</em>).</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em><span class="n">gc</span></em>, <em><span class="n">path</span></em>, <em><span class="n">transform</span></em>, <em><span class="n">rgbFace</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.draw_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a> instance using the given affine transform.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.draw_text">
<code class="descname">draw_text</code><span class="sig-paren">(</span><em><span class="n">gc</span></em>, <em><span class="n">x</span></em>, <em><span class="n">y</span></em>, <em><span class="n">s</span></em>, <em><span class="n">prop</span></em>, <em><span class="n">angle</span></em>, <em><span class="n">ismath</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">mtext</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.draw_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.draw_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the text instance.</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>gc</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></a></span></dt><dd><p>The graphics context.</p>
</dd>
<dt><strong>x</strong><span class="classifier">float</span></dt><dd><p>The x location of the text in display coords.</p>
</dd>
<dt><strong>y</strong><span class="classifier">float</span></dt><dd><p>The y location of the text baseline in display coords.</p>
</dd>
<dt><strong>s</strong><span class="classifier">str</span></dt><dd><p>The text string.</p>
</dd>
<dt><strong>prop</strong><span class="classifier"><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a></span></dt><dd><p>The font properties.</p>
</dd>
<dt><strong>angle</strong><span class="classifier">float</span></dt><dd><p>The rotation angle in degrees anti-clockwise.</p>
</dd>
<dt><strong>mtext</strong><span class="classifier"><a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a></span></dt><dd><p>The original text object to be rendered.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p><strong>Note for backend implementers:</strong></p>
<p>When you are trying to determine if you have gotten your bounding box
right (which is what enables the text layout/alignment to work
properly), it helps to change the line in text.py:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="mi">0</span><span class="p">:</span> <span class="n">bbox_artist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">)</span>
</pre></div>
</div>
<p>to if 1, and then the actual bounding box will be plotted along with
your text.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.flipy">
<code class="descname">flipy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.flipy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.flipy" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether y values increase from top to bottom.</p>
<p>Note that this only affects drawing of texts and images.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.get_canvas_width_height">
<code class="descname">get_canvas_width_height</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.get_canvas_width_height"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.get_canvas_width_height" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the canvas width and height in display coords.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em><span class="n">s</span></em>, <em><span class="n">prop</span></em>, <em><span class="n">ismath</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.get_text_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the width, height, and descent (offset from the bottom
to the baseline), in display coords, of the string <em>s</em> with
<a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a> <em>prop</em>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.new_gc">
<code class="descname">new_gc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.new_gc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.new_gc" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an instance of a <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_template.RendererTemplate.points_to_pixels">
<code class="descname">points_to_pixels</code><span class="sig-paren">(</span><em><span class="n">points</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#RendererTemplate.points_to_pixels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.RendererTemplate.points_to_pixels" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert points to display units.</p>
<p>You need to override this function (unless your backend
doesn't have a dpi, e.g., postscript or svg). Some imaging
systems assume some value for pixels per inch:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">points</span> <span class="n">to</span> <span class="n">pixels</span> <span class="o">=</span> <span class="n">points</span> <span class="o">*</span> <span class="n">pixels_per_inch</span><span class="o">/</span><span class="mi">72</span> <span class="o">*</span> <span class="n">dpi</span><span class="o">/</span><span class="mi">72</span>
</pre></div>
</div>
<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>points</strong><span class="classifier">float or array-like</span></dt><dd><p>a float or a numpy array of float</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>Points converted to pixels</dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.backends.backend_template.draw_if_interactive">
<code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">draw_if_interactive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#draw_if_interactive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.draw_if_interactive" title="Permalink to this definition">¶</a></dt>
<dd><p>For image backends - is not required.
For GUI backends - this should be overridden if drawing should be done in
interactive python mode.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.backends.backend_template.new_figure_manager">
<code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">new_figure_manager</code><span class="sig-paren">(</span><em>num</em>, <em>*args</em>, <em>FigureClass=<class 'matplotlib.figure.Figure'></em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#new_figure_manager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.new_figure_manager" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new figure manager instance.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.backends.backend_template.new_figure_manager_given_figure">
<code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">new_figure_manager_given_figure</code><span class="sig-paren">(</span><em><span class="n">num</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#new_figure_manager_given_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.new_figure_manager_given_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new figure manager instance for the given figure.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.backends.backend_template.show">
<code class="descclassname">matplotlib.backends.backend_template.</code><code class="descname">show</code><span class="sig-paren">(</span><em><span class="o">*</span></em>, <em><span class="n">block</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_template.html#show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_template.show" title="Permalink to this definition">¶</a></dt>
<dd><p>For image backends - is not required.
For GUI backends - show() is usually the last line of a pyplot script and
tells the backend that it is time to draw. In interactive mode, this
should do nothing.</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 - 2021 The Matplotlib development team.
<br />
Last updated on Aug 13, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.
Doc version v3.4.3-2-ge48e4acce0.
</div>
</footer>
</body>
</html>