-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_cairo_api.html
More file actions
527 lines (471 loc) · 43.8 KB
/
backend_cairo_api.html
File metadata and controls
527 lines (471 loc) · 43.8 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
<!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_cairo — Matplotlib 3.3.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.1-2-ge49322daa" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script 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/language_data.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.3.1 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_gtk3agg" href="backend_gtk3agg_api.html" />
<link rel="prev" title="matplotlib.backends.backend_agg" href="backend_agg_api.html" />
<link rel="top" title="Matplotlib 3.3.1 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_cairo_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.1). For the latest version see <a href="https://matplotlib.org/stable/api/backend_cairo_api.html">https://matplotlib.org/stable/api/backend_cairo_api.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.1</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="backend_gtk3agg_api.html" title="matplotlib.backends.backend_gtk3agg"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_agg_api.html" title="matplotlib.backends.backend_agg"
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_cairo</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_cairo</span></code></a><ul>
<li><a class="reference internal" href="#a-cairo-backend-for-matplotlib">A Cairo backend for matplotlib</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li><a href="index_backend_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a><ul>
<li>Previous: <a href="backend_agg_api.html" title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_agg</span></code></a></li>
<li>Next: <a href="backend_gtk3agg_api.html" title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_gtk3agg</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_cairo_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_cairo">
<span id="matplotlib-backends-backend-cairo"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_cairo" title="matplotlib.backends.backend_cairo"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_cairo</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_cairo" title="Permalink to this headline">¶</a></h1>
<div class="section" id="a-cairo-backend-for-matplotlib">
<h2>A Cairo backend for matplotlib<a class="headerlink" href="#a-cairo-backend-for-matplotlib" title="Permalink to this headline">¶</a></h2>
<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">Author:</th><td class="field-body">Steve Chaplin and others</td>
</tr>
</tbody>
</table>
<p>This backend depends on cairocffi or pycairo.</p>
<dl class="py attribute">
<dt id="matplotlib.backends.backend_cairo.FigureCanvas">
<code class="descclassname">matplotlib.backends.backend_cairo.</code><code class="descname">FigureCanvas</code><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo" title="matplotlib.backends.backend_cairo.FigureCanvasCairo"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_cairo.FigureCanvasCairo</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_cairo.</code><code class="descname">FigureCanvasCairo</code><span class="sig-paren">(</span><em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#FigureCanvasCairo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo" 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>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.copy_from_bbox">
<code class="descname">copy_from_bbox</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">bbox</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#FigureCanvasCairo.copy_from_bbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.copy_from_bbox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_pdf">
<code class="descname">print_pdf</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</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_cairo.html#FigureCanvasCairo.print_pdf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_pdf" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_png">
<code class="descname">print_png</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#FigureCanvasCairo.print_png"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_png" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_ps">
<code class="descname">print_ps</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</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_cairo.html#FigureCanvasCairo.print_ps"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_ps" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_raw">
<code class="descname">print_raw</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_raw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_rgba">
<code class="descname">print_rgba</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#FigureCanvasCairo.print_rgba"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_rgba" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_svg">
<code class="descname">print_svg</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</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_cairo.html#FigureCanvasCairo.print_svg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_svg" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.print_svgz">
<code class="descname">print_svgz</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fobj</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_cairo.html#FigureCanvasCairo.print_svgz"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.print_svgz" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.FigureCanvasCairo.restore_region">
<code class="descname">restore_region</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">region</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#FigureCanvasCairo.restore_region"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.FigureCanvasCairo.restore_region" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_cairo.</code><code class="descname">GraphicsContextCairo</code><span class="sig-paren">(</span><em><span class="n">renderer</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo" 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>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.get_rgb">
<code class="descname">get_rgb</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.get_rgb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.get_rgb" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple of three or four floats from 0-1.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.restore">
<code class="descname">restore</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.restore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.restore" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore the graphics context from the stack - needed only
for backends that save graphics contexts on a stack.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_alpha">
<code class="descname">set_alpha</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">alpha</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_alpha"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the alpha value used for blending - not supported on all backends.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">alpha=None</span></code> (the default), the alpha components of the
foreground and fill colors will be used to set their respective
transparencies (where applicable); otherwise, <code class="docutils literal notranslate"><span class="pre">alpha</span></code> will override
them.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_capstyle">
<code class="descname">set_capstyle</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">cs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_capstyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_capstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the capstyle to be one of ('butt', 'round', 'projecting').</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_clip_path">
<code class="descname">set_clip_path</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_clip_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the clip path and transformation.</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>path</strong><span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.TransformedPath" title="matplotlib.transforms.TransformedPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransformedPath</span></code></a> or None</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_clip_rectangle">
<code class="descname">set_clip_rectangle</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">rectangle</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_clip_rectangle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_clip_rectangle" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the clip rectangle with sequence (left, bottom, width, height)</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_dashes">
<code class="descname">set_dashes</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">offset</span></em>, <em><span class="n">dashes</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_dashes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_dashes" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dash style for the gc.</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>dash_offset</strong><span class="classifier">float or None</span></dt><dd><p>The offset (usually 0).</p>
</dd>
<dt><strong>dash_list</strong><span class="classifier">array-like or None</span></dt><dd><p>The on-off sequence as points.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p><code class="docutils literal notranslate"><span class="pre">(None,</span> <span class="pre">None)</span></code> specifies a solid line.</p>
<p>See p. 107 of to PostScript <a class="reference external" href="https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF">blue book</a> for more info.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_foreground">
<code class="descname">set_foreground</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fg</span></em>, <em><span class="n">isRGBA</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_cairo.html#GraphicsContextCairo.set_foreground"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_foreground" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the foreground color.</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>fg</strong><span class="classifier">color</span></dt><dd></dd>
<dt><strong>isRGBA</strong><span class="classifier">bool</span></dt><dd><p>If <em>fg</em> is known to be an <code class="docutils literal notranslate"><span class="pre">(r,</span> <span class="pre">g,</span> <span class="pre">b,</span> <span class="pre">a)</span></code> tuple, <em>isRGBA</em> can be
set to True to improve performance.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_joinstyle">
<code class="descname">set_joinstyle</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">js</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_joinstyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_joinstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the join style to be one of ('miter', 'round', 'bevel').</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.GraphicsContextCairo.set_linewidth">
<code class="descname">set_linewidth</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">w</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#GraphicsContextCairo.set_linewidth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.GraphicsContextCairo.set_linewidth" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the linewidth in points.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backends.backend_cairo.RendererCairo">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_cairo.</code><code class="descname">RendererCairo</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_cairo.html#RendererCairo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo" 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>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.RendererCairo.draw_image">
<code class="descname">draw_image</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <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_cairo.html#RendererCairo.draw_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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">array-like, shape=(N, M, 4), dtype=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_cairo.RendererCairo.draw_image" title="matplotlib.backends.backend_cairo.RendererCairo.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_cairo.RendererCairo.draw_markers">
<code class="descname">draw_markers</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">gc</span></em>, <em><span class="n">marker_path</span></em>, <em><span class="n">marker_trans</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_cairo.html#RendererCairo.draw_markers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.draw_markers" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a marker at each of the vertices in path.</p>
<p>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_cairo.RendererCairo.draw_path" title="matplotlib.backends.backend_cairo.RendererCairo.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"><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>marker_trans</strong><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>An affine transform applied to the marker.</p>
</dd>
<dt><strong>trans</strong><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>An affine transform applied to the path.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.RendererCairo.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <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_cairo.html#RendererCairo.draw_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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_cairo.RendererCairo.draw_text">
<code class="descname">draw_text</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <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_cairo.html#RendererCairo.draw_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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_cairo.RendererCairo.fontangles">
<em class="property">property </em><code class="descname">fontangles</code><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.fontangles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.RendererCairo.fontweights">
<em class="property">property </em><code class="descname">fontweights</code><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.fontweights" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.RendererCairo.get_canvas_width_height">
<code class="descname">get_canvas_width_height</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#RendererCairo.get_canvas_width_height"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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_cairo.RendererCairo.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <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_cairo.html#RendererCairo.get_text_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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_cairo.RendererCairo.new_gc">
<code class="descname">new_gc</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#RendererCairo.new_gc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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_cairo.RendererCairo.points_to_pixels">
<code class="descname">points_to_pixels</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">points</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#RendererCairo.points_to_pixels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.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>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.RendererCairo.set_ctx_from_surface">
<code class="descname">set_ctx_from_surface</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">surface</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#RendererCairo.set_ctx_from_surface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.set_ctx_from_surface" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backends.backend_cairo.RendererCairo.set_width_height">
<code class="descname">set_width_height</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_cairo.html#RendererCairo.set_width_height"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_cairo.RendererCairo.set_width_height" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Aug 14, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.3.1-2-ge49322daa.
</div>
</footer>
</body>
</html>