-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_agg_api.html
More file actions
582 lines (518 loc) · 41.3 KB
/
backend_agg_api.html
File metadata and controls
582 lines (518 loc) · 41.3 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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.backends.backend_agg — Matplotlib 2.2.2 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.2 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="top" title="Matplotlib 2.2.2 documentation" href="../index.html" />
<link rel="up" title="backends" href="index_backend_api.html" />
<link rel="next" title="matplotlib.backends.backend_cairo" href="backend_cairo_api.html" />
<link rel="prev" title="matplotlib.backend_tools" href="backend_tools_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_agg_api.html" />
<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 (v2.2.2). For the latest version see <a href="https://matplotlib.org/stable/api/backend_agg_api.html">https://matplotlib.org/stable/api/backend_agg_api.html</a></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 2.2.2</span></div>
<img src="../_static/logo2.png" 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>
<div class="related">
<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_cairo_api.html" title="matplotlib.backends.backend_cairo"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_tools_api.html" title="matplotlib.backend_tools"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" >The Matplotlib API</a> »</li>
<li><a href="index_backend_api.html" accesskey="U">backends</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li><a href="index_backend_api.html">backends</a><ul>
<li>Previous: <a href="backend_tools_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backend_tools</span></code></a></li>
<li>Next: <a href="backend_cairo_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_cairo</span></code></a></li>
</ul></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_agg_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">
<div class="section" id="module-matplotlib.backends.backend_agg">
<span id="matplotlib-backends-backend-agg"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_agg" title="matplotlib.backends.backend_agg"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_agg</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_agg" title="Permalink to this headline">¶</a></h1>
<p>An agg <a class="reference external" href="http://antigrain.com/">http://antigrain.com/</a> backend</p>
<p>Features that are implemented</p>
<blockquote>
<div><ul class="simple">
<li>capstyles and join styles</li>
<li>dashes</li>
<li>linewidth</li>
<li>lines, rectangles, ellipses</li>
<li>clipping to a rectangle</li>
<li>output to RGBA and PNG, optionally JPEG and TIFF</li>
<li>alpha blending</li>
<li>DPI scaling properly - everything scales properly (dashes, linewidths, etc)</li>
<li>draw polygon</li>
<li>freetype2 w/ ft2font</li>
</ul>
</div></blockquote>
<p>TODO:</p>
<blockquote>
<div><ul class="simple">
<li>integrate screen dpi w/ ppi and text</li>
</ul>
</div></blockquote>
<dl class="attribute">
<dt id="matplotlib.backends.backend_agg.FigureCanvas">
<code class="descclassname">matplotlib.backends.backend_agg.</code><code class="descname">FigureCanvas</code><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_agg.FigureCanvasAgg" title="matplotlib.backends.backend_agg.FigureCanvasAgg"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_agg.FigureCanvasAgg</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_agg.</code><code class="descname">FigureCanvasAgg</code><span class="sig-paren">(</span><em>figure</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg" 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>
<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-delimiter">:</span> <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">matplotlib.figure.Figure</span></code></a></span></dt>
<dd><p class="first last">A high-level Figure instance</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.buffer_rgba">
<code class="descname">buffer_rgba</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.buffer_rgba"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.buffer_rgba" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the image as an RGBA byte string</p>
<p><a class="reference internal" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.draw" title="matplotlib.backends.backend_agg.FigureCanvasAgg.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw</span></code></a> must be called at least once before this function will work and
to update the renderer for any subsequent changes to the 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">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>bytes</strong></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.copy_from_bbox">
<code class="descname">copy_from_bbox</code><span class="sig-paren">(</span><em>bbox</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.copy_from_bbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.copy_from_bbox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.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_agg.html#FigureCanvasAgg.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the figure using the renderer</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.get_renderer">
<code class="descname">get_renderer</code><span class="sig-paren">(</span><em>cleared=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.get_renderer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.get_renderer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpeg">
<code class="descname">print_jpeg</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpeg" title="Permalink to this definition">¶</a></dt>
<dd><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">Other Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>quality</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first last">The image quality, on a scale from 1 (worst) to
95 (best). The default is 95, if not given in the
matplotlibrc file in the savefig.jpeg_quality parameter.
Values above 95 should be avoided; 100 completely
disables the JPEG quantization stage.</p>
</dd>
<dt><strong>optimize</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If present, indicates that the encoder should
make an extra pass over the image in order to select
optimal encoder settings.</p>
</dd>
<dt><strong>progressive</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If present, indicates that this image
should be stored as a progressive JPEG file.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpg">
<code class="descname">print_jpg</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.print_jpg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpg" title="Permalink to this definition">¶</a></dt>
<dd><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">Other Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>quality</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first last">The image quality, on a scale from 1 (worst) to
95 (best). The default is 95, if not given in the
matplotlibrc file in the savefig.jpeg_quality parameter.
Values above 95 should be avoided; 100 completely
disables the JPEG quantization stage.</p>
</dd>
<dt><strong>optimize</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If present, indicates that the encoder should
make an extra pass over the image in order to select
optimal encoder settings.</p>
</dd>
<dt><strong>progressive</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If present, indicates that this image
should be stored as a progressive JPEG file.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_png">
<code class="descname">print_png</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.print_png"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_png" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_raw">
<code class="descname">print_raw</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.print_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_raw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_rgba">
<code class="descname">print_rgba</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_rgba" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_tif">
<code class="descname">print_tif</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.print_tif"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_tif" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_tiff">
<code class="descname">print_tiff</code><span class="sig-paren">(</span><em>filename_or_obj</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_tiff" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.print_to_buffer">
<code class="descname">print_to_buffer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.print_to_buffer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.print_to_buffer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.restore_region">
<code class="descname">restore_region</code><span class="sig-paren">(</span><em>region</em>, <em>bbox=None</em>, <em>xy=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.restore_region"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.restore_region" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.tostring_argb">
<code class="descname">tostring_argb</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.tostring_argb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.tostring_argb" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the image as an ARGB byte string</p>
<p><a class="reference internal" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.draw" title="matplotlib.backends.backend_agg.FigureCanvasAgg.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw</span></code></a> must be called at least once before this function will work and
to update the renderer for any subsequent changes to the 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">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>bytes</strong></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.FigureCanvasAgg.tostring_rgb">
<code class="descname">tostring_rgb</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#FigureCanvasAgg.tostring_rgb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.tostring_rgb" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the image as an RGB byte string</p>
<p><a class="reference internal" href="#matplotlib.backends.backend_agg.FigureCanvasAgg.draw" title="matplotlib.backends.backend_agg.FigureCanvasAgg.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw</span></code></a> must be called at least once before this function will work and
to update the renderer for any subsequent changes to the 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">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>bytes</strong></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_agg.RendererAgg">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_agg.</code><code class="descname">RendererAgg</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>dpi</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg" 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 all the drawing primitives using a graphics
context instance that controls the colors/styles</p>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.buffer_rgba">
<code class="descname">buffer_rgba</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.buffer_rgba"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.buffer_rgba" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.clear" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_agg.RendererAgg.debug">
<code class="descname">debug</code><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.debug" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified">Deprecated since version 2.2: </span>The debug function was deprecated in version 2.2.</p>
</div>
<p></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.draw_markers">
<code class="descname">draw_markers</code><span class="sig-paren">(</span><em>*kl</em>, <em>**kw</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.draw_markers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.draw_markers" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws a marker at each of the vertices in path. This includes
all vertices, including control points on curves. To avoid
that behavior, those vertices should be removed before calling
this function.</p>
<p>This provides a fallback implementation of draw_markers that
makes multiple calls to <a class="reference internal" href="#matplotlib.backends.backend_agg.RendererAgg.draw_path" title="matplotlib.backends.backend_agg.RendererAgg.draw_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_path()</span></code></a>. Some backends may
want to override this method in order to draw the marker only
once and reuse it multiple times.</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-delimiter">:</span> <span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code></span></dt>
<dd><p class="first last">The graphics context</p>
</dd>
<dt><strong>marker_trans</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Transform</span></code></a></span></dt>
<dd><p class="first last">An affine transform applied to the marker.</p>
</dd>
<dt><strong>trans</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.transforms.Transform</span></code></a></span></dt>
<dd><p class="first last">An affine transform applied to the path.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.draw_mathtext">
<code class="descname">draw_mathtext</code><span class="sig-paren">(</span><em>gc</em>, <em>x</em>, <em>y</em>, <em>s</em>, <em>prop</em>, <em>angle</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.draw_mathtext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.draw_mathtext" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the math text using matplotlib.mathtext</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>gc</em>, <em>path</em>, <em>transform</em>, <em>rgbFace=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.draw_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the path</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.draw_path_collection">
<code class="descname">draw_path_collection</code><span class="sig-paren">(</span><em>*kl</em>, <em>**kw</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.draw_path_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.draw_path_collection" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws a collection of paths selecting drawing properties from
the lists <em>facecolors</em>, <em>edgecolors</em>, <em>linewidths</em>,
<em>linestyles</em> and <em>antialiaseds</em>. <em>offsets</em> is a list of
offsets to apply to each of the paths. The offsets in
<em>offsets</em> are first transformed by <em>offsetTrans</em> before being
applied. <em>offset_position</em> may be either “screen” or “data”
depending on the space that the offsets are in.</p>
<p>This provides a fallback implementation of
<a class="reference internal" href="#matplotlib.backends.backend_agg.RendererAgg.draw_path_collection" title="matplotlib.backends.backend_agg.RendererAgg.draw_path_collection"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_path_collection()</span></code></a> that makes multiple calls to
<a class="reference internal" href="#matplotlib.backends.backend_agg.RendererAgg.draw_path" title="matplotlib.backends.backend_agg.RendererAgg.draw_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_path()</span></code></a>. Some backends may want to override this in
order to render each set of path data only once, and then
reference that path multiple times with the different offsets,
colors, styles etc. The generator methods
<code class="xref py py-meth docutils literal notranslate"><span class="pre">_iter_collection_raw_paths()</span></code> and
<code class="xref py py-meth docutils literal notranslate"><span class="pre">_iter_collection()</span></code> are provided to help with (and
standardize) the implementation across backends. It is highly
recommended to use those generators, so that changes to the
behavior of <a class="reference internal" href="#matplotlib.backends.backend_agg.RendererAgg.draw_path_collection" title="matplotlib.backends.backend_agg.RendererAgg.draw_path_collection"><code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_path_collection()</span></code></a> can be made globally.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.draw_tex">
<code class="descname">draw_tex</code><span class="sig-paren">(</span><em>gc</em>, <em>x</em>, <em>y</em>, <em>s</em>, <em>prop</em>, <em>angle</em>, <em>ismath='TeX!'</em>, <em>mtext=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.draw_tex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.draw_tex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.draw_text">
<code class="descname">draw_text</code><span class="sig-paren">(</span><em>gc</em>, <em>x</em>, <em>y</em>, <em>s</em>, <em>prop</em>, <em>angle</em>, <em>ismath=False</em>, <em>mtext=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.draw_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.draw_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the text</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.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_agg.html#RendererAgg.get_canvas_width_height"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.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="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em>s</em>, <em>prop</em>, <em>ismath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.get_text_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.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-class docutils literal notranslate"><span class="pre">FontProperties</span></code></a> <em>prop</em></p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_agg.RendererAgg.lock">
<code class="descname">lock</code><em class="property"> = <unlocked _thread.RLock object owner=0 count=0></em><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.lock" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.option_image_nocomposite">
<code class="descname">option_image_nocomposite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.option_image_nocomposite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.option_image_nocomposite" title="Permalink to this definition">¶</a></dt>
<dd><p>override this method for renderers that do not necessarily always
want to rescale and composite raster images. (like SVG, PDF, or PS)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.option_scale_image">
<code class="descname">option_scale_image</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.option_scale_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.option_scale_image" title="Permalink to this definition">¶</a></dt>
<dd><p>agg backend doesn’t support arbitrary scaling of image.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.points_to_pixels">
<code class="descname">points_to_pixels</code><span class="sig-paren">(</span><em>points</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.points_to_pixels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.points_to_pixels" title="Permalink to this definition">¶</a></dt>
<dd><p>convert point measures to pixes using dpi and the pixels per
inch of the display</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.restore_region">
<code class="descname">restore_region</code><span class="sig-paren">(</span><em>region</em>, <em>bbox=None</em>, <em>xy=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.restore_region"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.restore_region" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore the saved region. If bbox (instance of BboxBase, or
its extents) is given, only the region specified by the bbox
will be restored. <em>xy</em> (a tuple of two floasts) optionally
specifies the new position (the LLC of the original region,
not the LLC of the bbox) where the region will be restored.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">region</span> <span class="o">=</span> <span class="n">renderer</span><span class="o">.</span><span class="n">copy_from_bbox</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">x1</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">x2</span><span class="p">,</span> <span class="n">y2</span> <span class="o">=</span> <span class="n">region</span><span class="o">.</span><span class="n">get_extents</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">renderer</span><span class="o">.</span><span class="n">restore_region</span><span class="p">(</span><span class="n">region</span><span class="p">,</span> <span class="n">bbox</span><span class="o">=</span><span class="p">(</span><span class="n">x1</span><span class="o">+</span><span class="n">dx</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">x2</span><span class="p">,</span> <span class="n">y2</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">xy</span><span class="o">=</span><span class="p">(</span><span class="n">x1</span><span class="o">-</span><span class="n">dx</span><span class="p">,</span> <span class="n">y1</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.start_filter">
<code class="descname">start_filter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.start_filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.start_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Start filtering. It simply create a new canvas (the old one is saved).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.stop_filter">
<code class="descname">stop_filter</code><span class="sig-paren">(</span><em>post_processing</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.stop_filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.stop_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the plot in the current canvas as a image and apply
the <em>post_processing</em> function.</p>
<blockquote>
<div><dl class="docutils">
<dt>def post_processing(image, dpi):</dt>
<dd># ny, nx, depth = image.shape
# image (numpy array) has RGBA channels and has a depth of 4.
…
# create a new_image (numpy array of 4 channels, size can be
# different). The resulting image may have offsets from
# lower-left corner of the original image
return new_image, offset_x, offset_y</dd>
</dl>
</div></blockquote>
<p>The saved renderer is restored and the returned image from
post_processing is plotted (using draw_image) on it.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.tostring_argb">
<code class="descname">tostring_argb</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.tostring_argb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.tostring_argb" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.tostring_rgb">
<code class="descname">tostring_rgb</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.tostring_rgb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.tostring_rgb" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_agg.RendererAgg.tostring_rgba_minimized">
<code class="descname">tostring_rgba_minimized</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#RendererAgg.tostring_rgba_minimized"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.RendererAgg.tostring_rgba_minimized" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_agg.get_hinting_flag">
<code class="descclassname">matplotlib.backends.backend_agg.</code><code class="descname">get_hinting_flag</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_agg.html#get_hinting_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_agg.get_hinting_flag" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Jun 28, 2018.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.7.5.
Doc version v2.2.2-101-g15e1eadd0.
</div>
</body>
<footer>
</footer>
</html>