-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_bases_api.html
More file actions
1914 lines (1698 loc) · 130 KB
/
backend_bases_api.html
File metadata and controls
1914 lines (1698 loc) · 130 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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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.backend_bases — Matplotlib 1.4.3 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.4.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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 1.4.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.4.3 documentation" href="../index.html" />
<link rel="up" title="backends" href="index_backend_api.html" />
<link rel="next" title="matplotlib.backends.backend_gtkagg" href="backend_gtkagg_api.html" />
<link rel="prev" title="backends" href="index_backend_api.html" />
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_bases_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 (v1.4.3). For the latest version see <a href="https://matplotlib.org/stable/api/backend_bases_api.html">https://matplotlib.org/stable/api/backend_bases_api.html</a></div>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h3>We're updating the default styles for Matplotlib 2.0</h3>
<p>Learn what to expect in the <a href="/style_changes.html" style="font-weight: bold;
color: #11557C;">new updates</a></p>
</div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</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_gtkagg_api.html" title="matplotlib.backends.backend_gtkagg"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index_backend_api.html" title="backends"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</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">
<h4>Previous topic</h4>
<p class="topless"><a href="index_backend_api.html"
title="previous chapter">backends</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="backend_gtkagg_api.html"
title="next chapter"><tt class="docutils literal"><span class="pre">matplotlib.backends.backend_gtkagg</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/backend_bases_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-matplotlib.backend_bases">
<span id="matplotlib-backend-bases"></span><h1><a class="reference internal" href="#module-matplotlib.backend_bases" title="matplotlib.backend_bases"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.backend_bases</span></tt></a><a class="headerlink" href="#module-matplotlib.backend_bases" title="Permalink to this headline">¶</a></h1>
<p>Abstract base classes define the primitives that renderers and
graphics contexts must implement to serve as a matplotlib backend</p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><tt class="xref py py-class docutils literal"><span class="pre">RendererBase</span></tt></a></dt>
<dd>An abstract base class to handle drawing/rendering operations.</dd>
<dt><a class="reference internal" href="#matplotlib.backend_bases.FigureCanvasBase" title="matplotlib.backend_bases.FigureCanvasBase"><tt class="xref py py-class docutils literal"><span class="pre">FigureCanvasBase</span></tt></a></dt>
<dd>The abstraction layer that separates the
<a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></tt></a> from the backend specific
details like a user interface drawing area</dd>
<dt><a class="reference internal" href="#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><tt class="xref py py-class docutils literal"><span class="pre">GraphicsContextBase</span></tt></a></dt>
<dd>An abstract base class that provides color, line styles, etc...</dd>
<dt><a class="reference internal" href="#matplotlib.backend_bases.Event" title="matplotlib.backend_bases.Event"><tt class="xref py py-class docutils literal"><span class="pre">Event</span></tt></a></dt>
<dd>The base class for all of the matplotlib event
handling. Derived classes suh as <a class="reference internal" href="#matplotlib.backend_bases.KeyEvent" title="matplotlib.backend_bases.KeyEvent"><tt class="xref py py-class docutils literal"><span class="pre">KeyEvent</span></tt></a> and
<a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a> store the meta data like keys and buttons
pressed, x and y locations in pixel and
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> coordinates.</dd>
<dt><a class="reference internal" href="#matplotlib.backend_bases.ShowBase" title="matplotlib.backend_bases.ShowBase"><tt class="xref py py-class docutils literal"><span class="pre">ShowBase</span></tt></a></dt>
<dd>The base class for the Show class of each interactive backend;
the ‘show’ callable is then set to Show.__call__, inherited from
ShowBase.</dd>
</dl>
<dl class="class">
<dt id="matplotlib.backend_bases.CloseEvent">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">CloseEvent</tt><big>(</big><em>name</em>, <em>canvas</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.CloseEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_bases.Event" title="matplotlib.backend_bases.Event"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.backend_bases.Event</span></tt></a></p>
<p>An event triggered by a figure being closed</p>
<p>In addition to the <a class="reference internal" href="#matplotlib.backend_bases.Event" title="matplotlib.backend_bases.Event"><tt class="xref py py-class docutils literal"><span class="pre">Event</span></tt></a> attributes, the following event
attributes are defined:</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_bases.Cursors">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">Cursors</tt><a class="headerlink" href="#matplotlib.backend_bases.Cursors" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="matplotlib.backend_bases.Cursors.HAND">
<tt class="descname">HAND</tt><em class="property"> = 0</em><a class="headerlink" href="#matplotlib.backend_bases.Cursors.HAND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.Cursors.MOVE">
<tt class="descname">MOVE</tt><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.backend_bases.Cursors.MOVE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.Cursors.POINTER">
<tt class="descname">POINTER</tt><em class="property"> = 1</em><a class="headerlink" href="#matplotlib.backend_bases.Cursors.POINTER" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.Cursors.SELECT_REGION">
<tt class="descname">SELECT_REGION</tt><em class="property"> = 2</em><a class="headerlink" href="#matplotlib.backend_bases.Cursors.SELECT_REGION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_bases.DrawEvent">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">DrawEvent</tt><big>(</big><em>name</em>, <em>canvas</em>, <em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.DrawEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_bases.Event" title="matplotlib.backend_bases.Event"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.backend_bases.Event</span></tt></a></p>
<p>An event triggered by a draw operation on the canvas</p>
<p>In addition to the <a class="reference internal" href="#matplotlib.backend_bases.Event" title="matplotlib.backend_bases.Event"><tt class="xref py py-class docutils literal"><span class="pre">Event</span></tt></a> attributes, the following event
attributes are defined:</p>
<dl class="docutils">
<dt><em>renderer</em></dt>
<dd>the <a class="reference internal" href="#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><tt class="xref py py-class docutils literal"><span class="pre">RendererBase</span></tt></a> instance for the draw event</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_bases.Event">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">Event</tt><big>(</big><em>name</em>, <em>canvas</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.Event" title="Permalink to this definition">¶</a></dt>
<dd><p>A matplotlib event. Attach additional attributes as defined in
<a class="reference internal" href="#matplotlib.backend_bases.FigureCanvasBase.mpl_connect" title="matplotlib.backend_bases.FigureCanvasBase.mpl_connect"><tt class="xref py py-meth docutils literal"><span class="pre">FigureCanvasBase.mpl_connect()</span></tt></a>. The following attributes
are defined and shown with their default values</p>
<dl class="docutils">
<dt><em>name</em></dt>
<dd>the event name</dd>
<dt><em>canvas</em></dt>
<dd>the FigureCanvas instance generating the event</dd>
<dt><em>guiEvent</em></dt>
<dd>the GUI event that triggered the matplotlib event</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_bases.FigureCanvasBase">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">FigureCanvasBase</tt><big>(</big><em>figure</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>The canvas the figure renders into.</p>
<p>Public attributes</p>
<blockquote>
<div><dl class="docutils">
<dt><em>figure</em></dt>
<dd>A <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></tt></a> instance</dd>
</dl>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.blit">
<tt class="descname">blit</tt><big>(</big><em>bbox=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.blit" title="Permalink to this definition">¶</a></dt>
<dd><p>blit the canvas in bbox (default entire canvas)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.button_press_event">
<tt class="descname">button_press_event</tt><big>(</big><em>x</em>, <em>y</em>, <em>button</em>, <em>dblclick=False</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.button_press_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Backend derived classes should call this function on any mouse
button press. x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in <a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a>.</p>
<p>This method will be call all functions connected to the
‘button_press_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.button_release_event">
<tt class="descname">button_release_event</tt><big>(</big><em>x</em>, <em>y</em>, <em>button</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.button_release_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Backend derived classes should call this function on any mouse
button release.</p>
<dl class="docutils">
<dt><em>x</em></dt>
<dd>the canvas coordinates where 0=left</dd>
<dt><em>y</em></dt>
<dd>the canvas coordinates where 0=bottom</dd>
<dt><em>guiEvent</em></dt>
<dd>the native UI event that generated the mpl event</dd>
</dl>
<p>This method will be call all functions connected to the
‘button_release_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.close_event">
<tt class="descname">close_event</tt><big>(</big><em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.close_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This method will be called by all functions connected to the
‘close_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.CloseEvent" title="matplotlib.backend_bases.CloseEvent"><tt class="xref py py-class docutils literal"><span class="pre">CloseEvent</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.draw">
<tt class="descname">draw</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">Figure</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.draw_cursor">
<tt class="descname">draw_cursor</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.draw_cursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a cursor in the event.axes if inaxes is not None. Use
native GUI drawing for efficiency if possible</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.draw_event">
<tt class="descname">draw_event</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.draw_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This method will be call all functions connected to the
‘draw_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.DrawEvent" title="matplotlib.backend_bases.DrawEvent"><tt class="xref py py-class docutils literal"><span class="pre">DrawEvent</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.draw_idle">
<tt class="descname">draw_idle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.draw_idle" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="#matplotlib.backend_bases.FigureCanvasBase.draw" title="matplotlib.backend_bases.FigureCanvasBase.draw"><tt class="xref py py-meth docutils literal"><span class="pre">draw()</span></tt></a> only if idle; defaults to draw but backends can overrride</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.enter_notify_event">
<tt class="descname">enter_notify_event</tt><big>(</big><em>guiEvent=None</em>, <em>xy=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.enter_notify_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Backend derived classes should call this function when entering
canvas</p>
<dl class="docutils">
<dt><em>guiEvent</em></dt>
<dd>the native UI event that generated the mpl event</dd>
<dt><em>xy</em></dt>
<dd>the coordinate location of the pointer when the canvas is
entered</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.FigureCanvasBase.events">
<tt class="descname">events</tt><em class="property"> = [u'resize_event', u'draw_event', u'key_press_event', u'key_release_event', u'button_press_event', u'button_release_event', u'scroll_event', u'motion_notify_event', u'pick_event', u'idle_event', u'figure_enter_event', u'figure_leave_event', u'axes_enter_event', u'axes_leave_event', u'close_event']</em><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.events" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.FigureCanvasBase.filetypes">
<tt class="descname">filetypes</tt><em class="property"> = {u'pgf': u'PGF code for LaTeX', u'ps': u'Postscript', u'svg': u'Scalable Vector Graphics', u'rgba': u'Raw RGBA bitmap', u'raw': u'Raw RGBA bitmap', u'svgz': u'Scalable Vector Graphics', u'pdf': u'Portable Document Format', u'eps': u'Encapsulated Postscript', u'png': u'Portable Network Graphics'}</em><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.filetypes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.FigureCanvasBase.fixed_dpi">
<tt class="descname">fixed_dpi</tt><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.fixed_dpi" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.flush_events">
<tt class="descname">flush_events</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.flush_events" title="Permalink to this definition">¶</a></dt>
<dd><p>Flush the GUI events for the figure. Implemented only for
backends with GUIs.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.get_default_filename">
<tt class="descname">get_default_filename</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.get_default_filename" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a string, which includes extension, suitable for use as
a default filename.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.backend_bases.FigureCanvasBase.get_default_filetype">
<em class="property">classmethod </em><tt class="descname">get_default_filetype</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.get_default_filetype" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the default savefig file format as specified in rcParam
<tt class="docutils literal"><span class="pre">savefig.format</span></tt>. Returned string excludes period. Overridden
in backends that only support a single file type.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.backend_bases.FigureCanvasBase.get_supported_filetypes">
<em class="property">classmethod </em><tt class="descname">get_supported_filetypes</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.get_supported_filetypes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return dict of savefig file formats supported by this backend</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.backend_bases.FigureCanvasBase.get_supported_filetypes_grouped">
<em class="property">classmethod </em><tt class="descname">get_supported_filetypes_grouped</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.get_supported_filetypes_grouped" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dict of savefig file formats supported by this backend,
where the keys are a file type name, such as ‘Joint Photographic
Experts Group’, and the values are a list of filename extensions used
for that filetype, such as [‘jpg’, ‘jpeg’].</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.get_width_height">
<tt class="descname">get_width_height</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.get_width_height" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the figure width and height in points or pixels
(depending on the backend), truncated to integers</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.get_window_title">
<tt class="descname">get_window_title</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.get_window_title" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the title text of the window containing the figure.
Return None if there is no window (e.g., a PS backend).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.grab_mouse">
<tt class="descname">grab_mouse</tt><big>(</big><em>ax</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.grab_mouse" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the child axes which are currently grabbing the mouse events.
Usually called by the widgets themselves.
It is an error to call this if the mouse is already grabbed by
another axes.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.idle_event">
<tt class="descname">idle_event</tt><big>(</big><em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.idle_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when GUI is idle.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.is_saving">
<tt class="descname">is_saving</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.is_saving" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt> when the renderer is in the process of saving
to a file, rather than rendering for an on-screen buffer.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.key_press_event">
<tt class="descname">key_press_event</tt><big>(</big><em>key</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.key_press_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This method will be call all functions connected to the
‘key_press_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.KeyEvent" title="matplotlib.backend_bases.KeyEvent"><tt class="xref py py-class docutils literal"><span class="pre">KeyEvent</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.key_release_event">
<tt class="descname">key_release_event</tt><big>(</big><em>key</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.key_release_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This method will be call all functions connected to the
‘key_release_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.KeyEvent" title="matplotlib.backend_bases.KeyEvent"><tt class="xref py py-class docutils literal"><span class="pre">KeyEvent</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.leave_notify_event">
<tt class="descname">leave_notify_event</tt><big>(</big><em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.leave_notify_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Backend derived classes should call this function when leaving
canvas</p>
<dl class="docutils">
<dt><em>guiEvent</em></dt>
<dd>the native UI event that generated the mpl event</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.motion_notify_event">
<tt class="descname">motion_notify_event</tt><big>(</big><em>x</em>, <em>y</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.motion_notify_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Backend derived classes should call this function on any
motion-notify-event.</p>
<dl class="docutils">
<dt><em>x</em></dt>
<dd>the canvas coordinates where 0=left</dd>
<dt><em>y</em></dt>
<dd>the canvas coordinates where 0=bottom</dd>
<dt><em>guiEvent</em></dt>
<dd>the native UI event that generated the mpl event</dd>
</dl>
<p>This method will be call all functions connected to the
‘motion_notify_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.mpl_connect">
<tt class="descname">mpl_connect</tt><big>(</big><em>s</em>, <em>func</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.mpl_connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect event with string <em>s</em> to <em>func</em>. The signature of <em>func</em> is:</p>
<div class="highlight-python"><div class="highlight"><pre>def func(event)
</pre></div>
</div>
<p>where event is a <a class="reference internal" href="#matplotlib.backend_bases.Event" title="matplotlib.backend_bases.Event"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.backend_bases.Event</span></tt></a>. The
following events are recognized</p>
<ul class="simple">
<li>‘button_press_event’</li>
<li>‘button_release_event’</li>
<li>‘draw_event’</li>
<li>‘key_press_event’</li>
<li>‘key_release_event’</li>
<li>‘motion_notify_event’</li>
<li>‘pick_event’</li>
<li>‘resize_event’</li>
<li>‘scroll_event’</li>
<li>‘figure_enter_event’,</li>
<li>‘figure_leave_event’,</li>
<li>‘axes_enter_event’,</li>
<li>‘axes_leave_event’</li>
<li>‘close_event’</li>
</ul>
<p>For the location events (button and key press/release), if the
mouse is over the axes, the variable <tt class="docutils literal"><span class="pre">event.inaxes</span></tt> will be
set to the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> the event occurs is
over, and additionally, the variables <tt class="docutils literal"><span class="pre">event.xdata</span></tt> and
<tt class="docutils literal"><span class="pre">event.ydata</span></tt> will be defined. This is the mouse location
in data coords. See
<a class="reference internal" href="#matplotlib.backend_bases.KeyEvent" title="matplotlib.backend_bases.KeyEvent"><tt class="xref py py-class docutils literal"><span class="pre">KeyEvent</span></tt></a> and
<a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a> for more info.</p>
<p>Return value is a connection id that can be used with
<tt class="xref py py-meth docutils literal"><span class="pre">mpl_disconnect()</span></tt>.</p>
<p>Example usage:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">on_press</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s">'you pressed'</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">button</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">xdata</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">ydata</span><span class="p">)</span>
<span class="n">cid</span> <span class="o">=</span> <span class="n">canvas</span><span class="o">.</span><span class="n">mpl_connect</span><span class="p">(</span><span class="s">'button_press_event'</span><span class="p">,</span> <span class="n">on_press</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.mpl_disconnect">
<tt class="descname">mpl_disconnect</tt><big>(</big><em>cid</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.mpl_disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect callback id cid</p>
<p>Example usage:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">cid</span> <span class="o">=</span> <span class="n">canvas</span><span class="o">.</span><span class="n">mpl_connect</span><span class="p">(</span><span class="s">'button_press_event'</span><span class="p">,</span> <span class="n">on_press</span><span class="p">)</span>
<span class="c">#...later</span>
<span class="n">canvas</span><span class="o">.</span><span class="n">mpl_disconnect</span><span class="p">(</span><span class="n">cid</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.new_timer">
<tt class="descname">new_timer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.new_timer" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new backend-specific subclass of
<tt class="xref py py-class docutils literal"><span class="pre">backend_bases.Timer</span></tt>. This is useful for getting periodic
events through the backend’s native event loop. Implemented only for
backends with GUIs.</p>
<p>optional arguments:</p>
<dl class="docutils">
<dt><em>interval</em></dt>
<dd>Timer interval in milliseconds</dd>
<dt><em>callbacks</em></dt>
<dd>Sequence of (func, args, kwargs) where func(<em>args, **kwargs) will
be executed by the timer every *interval</em>.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.onHilite">
<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.onHilite" title="Permalink to this definition">¶</a></dt>
<dd><p>Mouse event processor which highlights the artists
under the cursor. Connect this to the ‘motion_notify_event’
using:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">canvas</span><span class="o">.</span><span class="n">mpl_connect</span><span class="p">(</span><span class="s">'motion_notify_event'</span><span class="p">,</span><span class="n">canvas</span><span class="o">.</span><span class="n">onHilite</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.onRemove">
<tt class="descname">onRemove</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.onRemove" title="Permalink to this definition">¶</a></dt>
<dd><p>Mouse event processor which removes the top artist
under the cursor. Connect this to the ‘mouse_press_event’
using:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">canvas</span><span class="o">.</span><span class="n">mpl_connect</span><span class="p">(</span><span class="s">'mouse_press_event'</span><span class="p">,</span><span class="n">canvas</span><span class="o">.</span><span class="n">onRemove</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.pick">
<tt class="descname">pick</tt><big>(</big><em>mouseevent</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.pick" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.pick_event">
<tt class="descname">pick_event</tt><big>(</big><em>mouseevent</em>, <em>artist</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.pick_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This method will be called by artists who are picked and will
fire off <a class="reference internal" href="#matplotlib.backend_bases.PickEvent" title="matplotlib.backend_bases.PickEvent"><tt class="xref py py-class docutils literal"><span class="pre">PickEvent</span></tt></a> callbacks registered listeners</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.print_figure">
<tt class="descname">print_figure</tt><big>(</big><em>filename</em>, <em>dpi=None</em>, <em>facecolor=u'w'</em>, <em>edgecolor=u'w'</em>, <em>orientation=u'portrait'</em>, <em>format=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.print_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the figure to hardcopy. Set the figure patch face and edge
colors. This is useful because some of the GUIs have a gray figure
face color background and you’ll probably want to override this on
hardcopy.</p>
<p>Arguments are:</p>
<dl class="docutils">
<dt><em>filename</em></dt>
<dd>can also be a file object on image backends</dd>
<dt><em>orientation</em></dt>
<dd>only currently applies to PostScript printing.</dd>
<dt><em>dpi</em></dt>
<dd>the dots per inch to save the figure in; if None, use savefig.dpi</dd>
<dt><em>facecolor</em></dt>
<dd>the facecolor of the figure</dd>
<dt><em>edgecolor</em></dt>
<dd>the edgecolor of the figure</dd>
<dt><em>orientation</em></dt>
<dd>landscape’ | ‘portrait’ (not supported on all backends)</dd>
<dt><em>format</em></dt>
<dd>when set, forcibly set the file format to save to</dd>
<dt><em>bbox_inches</em></dt>
<dd>Bbox in inches. Only the given portion of the figure is
saved. If ‘tight’, try to figure out the tight bbox of
the figure. If None, use savefig.bbox</dd>
<dt><em>pad_inches</em></dt>
<dd>Amount of padding around the figure when bbox_inches is
‘tight’. If None, use savefig.pad_inches</dd>
<dt><em>bbox_extra_artists</em></dt>
<dd>A list of extra artists that will be considered when the
tight bbox is calculated.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.release_mouse">
<tt class="descname">release_mouse</tt><big>(</big><em>ax</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.release_mouse" title="Permalink to this definition">¶</a></dt>
<dd><p>Release the mouse grab held by the axes, ax.
Usually called by the widgets.
It is ok to call this even if you ax doesn’t have the mouse
grab currently.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.resize">
<tt class="descname">resize</tt><big>(</big><em>w</em>, <em>h</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.resize" title="Permalink to this definition">¶</a></dt>
<dd><p>set the canvas size in pixels</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.resize_event">
<tt class="descname">resize_event</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.resize_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This method will be call all functions connected to the
‘resize_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.ResizeEvent" title="matplotlib.backend_bases.ResizeEvent"><tt class="xref py py-class docutils literal"><span class="pre">ResizeEvent</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.scroll_event">
<tt class="descname">scroll_event</tt><big>(</big><em>x</em>, <em>y</em>, <em>step</em>, <em>guiEvent=None</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.scroll_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Backend derived classes should call this function on any
scroll wheel event. x,y are the canvas coords: 0,0 is lower,
left. button and key are as defined in MouseEvent.</p>
<p>This method will be call all functions connected to the
‘scroll_event’ with a <a class="reference internal" href="#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><tt class="xref py py-class docutils literal"><span class="pre">MouseEvent</span></tt></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.set_window_title">
<tt class="descname">set_window_title</tt><big>(</big><em>title</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.set_window_title" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the title text of the window containing the figure. Note that
this has no effect if there is no window (e.g., a PS backend).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.start_event_loop">
<tt class="descname">start_event_loop</tt><big>(</big><em>timeout</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.start_event_loop" title="Permalink to this definition">¶</a></dt>
<dd><p>Start an event loop. This is used to start a blocking event
loop so that interactive functions, such as ginput and
waitforbuttonpress, can wait for events. This should not be
confused with the main GUI event loop, which is always running
and has nothing to do with this.</p>
<p>This is implemented only for backends with GUIs.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.start_event_loop_default">
<tt class="descname">start_event_loop_default</tt><big>(</big><em>timeout=0</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.start_event_loop_default" title="Permalink to this definition">¶</a></dt>
<dd><p>Start an event loop. This is used to start a blocking event
loop so that interactive functions, such as ginput and
waitforbuttonpress, can wait for events. This should not be
confused with the main GUI event loop, which is always running
and has nothing to do with this.</p>
<p>This function provides default event loop functionality based
on time.sleep that is meant to be used until event loop
functions for each of the GUI backends can be written. As
such, it throws a deprecated warning.</p>
<p>Call signature:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">start_event_loop_default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">timeout</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
<p>This call blocks until a callback function triggers
stop_event_loop() or <em>timeout</em> is reached. If <em>timeout</em> is
<=0, never timeout.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.stop_event_loop">
<tt class="descname">stop_event_loop</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.stop_event_loop" title="Permalink to this definition">¶</a></dt>
<dd><p>Stop an event loop. This is used to stop a blocking event
loop so that interactive functions, such as ginput and
waitforbuttonpress, can wait for events.</p>
<p>This is implemented only for backends with GUIs.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.stop_event_loop_default">
<tt class="descname">stop_event_loop_default</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.stop_event_loop_default" title="Permalink to this definition">¶</a></dt>
<dd><p>Stop an event loop. This is used to stop a blocking event
loop so that interactive functions, such as ginput and
waitforbuttonpress, can wait for events.</p>
<p>Call signature:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">stop_event_loop_default</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.FigureCanvasBase.supports_blit">
<tt class="descname">supports_blit</tt><em class="property"> = True</em><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.supports_blit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureCanvasBase.switch_backends">
<tt class="descname">switch_backends</tt><big>(</big><em>FigureCanvasClass</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureCanvasBase.switch_backends" title="Permalink to this definition">¶</a></dt>
<dd><p>Instantiate an instance of FigureCanvasClass</p>
<p>This is used for backend switching, e.g., to instantiate a
FigureCanvasPS from a FigureCanvasGTK. Note, deep copying is
not done, so any changes to one of the instances (e.g., setting
figure size or line props), will be reflected in the other</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_bases.FigureManagerBase">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">FigureManagerBase</tt><big>(</big><em>canvas</em>, <em>num</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>Helper class for pyplot mode, wraps everything up into a neat bundle</p>
<p>Public attibutes:</p>
<dl class="docutils">
<dt><em>canvas</em></dt>
<dd>A <a class="reference internal" href="#matplotlib.backend_bases.FigureCanvasBase" title="matplotlib.backend_bases.FigureCanvasBase"><tt class="xref py py-class docutils literal"><span class="pre">FigureCanvasBase</span></tt></a> instance</dd>
<dt><em>num</em></dt>
<dd>The figure number</dd>
</dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.destroy">
<tt class="descname">destroy</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.destroy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.full_screen_toggle">
<tt class="descname">full_screen_toggle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.full_screen_toggle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.get_window_title">
<tt class="descname">get_window_title</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.get_window_title" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the title text of the window containing the figure.
Return None for non-GUI backends (e.g., a PS backend).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.key_press">
<tt class="descname">key_press</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.key_press" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement the default mpl key bindings defined at
<a class="reference internal" href="../users/navigation_toolbar.html#key-event-handling"><em>Navigation Keyboard Shortcuts</em></a></p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.FigureManagerBase.key_press_handler_id">
<tt class="descname">key_press_handler_id</tt><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.key_press_handler_id" title="Permalink to this definition">¶</a></dt>
<dd><p>The returned id from connecting the default key handler via
<tt class="xref py py-meth docutils literal"><span class="pre">FigureCanvasBase.mpl_connnect()</span></tt>.</p>
<p>To disable default key press handling:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">manager</span><span class="p">,</span> <span class="n">canvas</span> <span class="o">=</span> <span class="n">figure</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">manager</span><span class="p">,</span> <span class="n">figure</span><span class="o">.</span><span class="n">canvas</span>
<span class="n">canvas</span><span class="o">.</span><span class="n">mpl_disconnect</span><span class="p">(</span><span class="n">manager</span><span class="o">.</span><span class="n">key_press_handler_id</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.resize">
<tt class="descname">resize</tt><big>(</big><em>w</em>, <em>h</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.resize" title="Permalink to this definition">¶</a></dt>
<dd><p>“For gui backends, resize the window (in pixels).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.set_window_title">
<tt class="descname">set_window_title</tt><big>(</big><em>title</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.set_window_title" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the title text of the window containing the figure. Note that
this has no effect for non-GUI backends (e.g., a PS backend).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.show">
<tt class="descname">show</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.show" title="Permalink to this definition">¶</a></dt>
<dd><p>For GUI backends, show the figure window and redraw.
For non-GUI backends, raise an exception to be caught
by <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure.show" title="matplotlib.figure.Figure.show"><tt class="xref py py-meth docutils literal"><span class="pre">show()</span></tt></a>, for an
optional warning.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.FigureManagerBase.show_popup">
<tt class="descname">show_popup</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.FigureManagerBase.show_popup" title="Permalink to this definition">¶</a></dt>
<dd><p>Display message in a popup – GUI only</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backend_bases.GraphicsContextBase">
<em class="property">class </em><tt class="descclassname">matplotlib.backend_bases.</tt><tt class="descname">GraphicsContextBase</tt><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase" title="Permalink to this definition">¶</a></dt>
<dd><p>An abstract base class that provides color, line styles, etc...</p>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.copy_properties">
<tt class="descname">copy_properties</tt><big>(</big><em>gc</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.copy_properties" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy properties from gc to self</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backend_bases.GraphicsContextBase.dashd">
<tt class="descname">dashd</tt><em class="property"> = {u'solid': (None, None), u'dashed': (0, (6.0, 6.0)), u'dotted': (0, (1.0, 3.0)), u'dashdot': (0, (3.0, 5.0, 1.0, 5.0))}</em><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.dashd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_alpha">
<tt class="descname">get_alpha</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the alpha value used for blending - not supported on
all backends</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_antialiased">
<tt class="descname">get_antialiased</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_antialiased" title="Permalink to this definition">¶</a></dt>
<dd><p>Return true if the object should try to do antialiased rendering</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_capstyle">
<tt class="descname">get_capstyle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_capstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the capstyle as a string in (‘butt’, ‘round’, ‘projecting’)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_clip_path">
<tt class="descname">get_clip_path</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the clip path in the form (path, transform), where path
is a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instance, and transform is
an affine transform to apply to the path before clipping.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_clip_rectangle">
<tt class="descname">get_clip_rectangle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_clip_rectangle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the clip rectangle as a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">Bbox</span></tt></a>
instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_dashes">
<tt class="descname">get_dashes</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_dashes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the dash information as an offset dashlist tuple.</p>
<p>The dash list is a even size list that gives the ink on, ink
off in pixels.</p>
<p>See p107 of to PostScript <a class="reference external" href="http://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF">BLUEBOOK</a>
for more info.</p>
<p>Default value is None</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_forced_alpha">
<tt class="descname">get_forced_alpha</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_forced_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the value given by get_alpha() should be used to
override any other alpha-channel values.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_gid">
<tt class="descname">get_gid</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the object identifier if one is set, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_hatch">
<tt class="descname">get_hatch</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_hatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the current hatch style</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_hatch_path">
<tt class="descname">get_hatch_path</tt><big>(</big><em>density=6.0</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_hatch_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a Path for the current hatch.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_joinstyle">
<tt class="descname">get_joinstyle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_joinstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the line join style as one of (‘miter’, ‘round’, ‘bevel’)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_linestyle">
<tt class="descname">get_linestyle</tt><big>(</big><em>style</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_linestyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the linestyle: one of (‘solid’, ‘dashed’, ‘dashdot’,
‘dotted’).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_linewidth">
<tt class="descname">get_linewidth</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_linewidth" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the line width in points as a scalar</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_rgb">
<tt class="descname">get_rgb</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_rgb" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a tuple of three or four floats from 0-1.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_sketch_params">
<tt class="descname">get_sketch_params</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_sketch_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the sketch parameters for the artist.</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"><p class="first"><strong>sketch_params</strong> : tuple or <tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt></p>
<p>A 3-tuple with the following elements:</p>
<blockquote>
<div><ul class="simple">
<li><tt class="xref py py-obj docutils literal"><span class="pre">scale</span></tt>: The amplitude of the wiggle perpendicular to the
source line.</li>
<li><tt class="xref py py-obj docutils literal"><span class="pre">length</span></tt>: The length of the wiggle along the line.</li>
<li><tt class="xref py py-obj docutils literal"><span class="pre">randomness</span></tt>: The scale factor by which the length is
shrunken or expanded.</li>
</ul>
</div></blockquote>
<p class="last">May return <tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt> if no sketch parameters were set.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_snap">
<tt class="descname">get_snap</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_snap" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the snap setting which may be:</p>
<blockquote>
<div><ul class="simple">
<li>True: snap vertices to the nearest pixel center</li>
<li>False: leave vertices as-is</li>
<li>None: (auto) If the path contains only rectilinear line
segments, round to the nearest pixel center</li>
</ul>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.get_url">
<tt class="descname">get_url</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.get_url" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a url if one is set, None otherwise</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.restore">
<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.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="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_alpha">
<tt class="descname">set_alpha</tt><big>(</big><em>alpha</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the alpha value used for blending - not supported on all backends.
If <tt class="docutils literal"><span class="pre">alpha=None</span></tt> (the default), the alpha components of the
foreground and fill colors will be used to set their respective
transparencies (where applicable); otherwise, <tt class="docutils literal"><span class="pre">alpha</span></tt> will override
them.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_antialiased">
<tt class="descname">set_antialiased</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_antialiased" title="Permalink to this definition">¶</a></dt>
<dd><p>True if object should be drawn with antialiased rendering</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_capstyle">
<tt class="descname">set_capstyle</tt><big>(</big><em>cs</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_capstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the capstyle as a string in (‘butt’, ‘round’, ‘projecting’)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_clip_path">
<tt class="descname">set_clip_path</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the clip path and transformation. Path should be a
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.TransformedPath" title="matplotlib.transforms.TransformedPath"><tt class="xref py py-class docutils literal"><span class="pre">TransformedPath</span></tt></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_clip_rectangle">
<tt class="descname">set_clip_rectangle</tt><big>(</big><em>rectangle</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.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="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_dashes">
<tt class="descname">set_dashes</tt><big>(</big><em>dash_offset</em>, <em>dash_list</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_dashes" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dash style for the gc.</p>
<dl class="docutils">
<dt><em>dash_offset</em></dt>
<dd>is the offset (usually 0).</dd>
<dt><em>dash_list</em></dt>
<dd>specifies the on-off sequence as points.
<tt class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></tt> specifies a solid line</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_foreground">
<tt class="descname">set_foreground</tt><big>(</big><em>fg</em>, <em>isRGBA=False</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_foreground" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the foreground color. fg can be a MATLAB format string, a
html hex color string, an rgb or rgba unit tuple, or a float between 0
and 1. In the latter case, grayscale is used.</p>
<p>If you know fg is rgba, set <tt class="docutils literal"><span class="pre">isRGBA=True</span></tt> for efficiency.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_gid">
<tt class="descname">set_gid</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the id.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backend_bases.GraphicsContextBase.set_graylevel">
<tt class="descname">set_graylevel</tt><big>(</big><em>frac</em><big>)</big><a class="headerlink" href="#matplotlib.backend_bases.GraphicsContextBase.set_graylevel" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the foreground color to be a gray level with <em>frac</em></p>
</dd></dl>
<dl class="method">