-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathapi.html
More file actions
2628 lines (2393 loc) · 162 KB
/
api.html
File metadata and controls
2628 lines (2393 loc) · 162 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>mplot3d API — Matplotlib 1.4.0 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.0',
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.0 documentation"
href="../../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.4.0 documentation" href="../../index.html" />
<link rel="up" title="mplot3d" href="index.html" />
<link rel="next" title="mplot3d FAQ" href="faq.html" />
<link rel="prev" title="mplot3d tutorial" href="tutorial.html" />
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<link rel="canonical" href="https://matplotlib.org/2.0.2/mpl_toolkits/mplot3d/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.0). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </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="faq.html" title="mplot3d FAQ"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="mplot3d tutorial"
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="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >Toolkits</a> »</li>
<li><a href="index.html" accesskey="U">mplot3d</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">mplot3d API</a><ul>
<li><a class="reference internal" href="#axes3d"><tt class="docutils literal"><span class="pre">axes3d</span></tt></a></li>
<li><a class="reference internal" href="#axis3d"><tt class="docutils literal"><span class="pre">axis3d</span></tt></a></li>
<li><a class="reference internal" href="#module-mpl_toolkits.mplot3d.art3d"><tt class="docutils literal"><span class="pre">art3d</span></tt></a></li>
<li><a class="reference internal" href="#module-mpl_toolkits.mplot3d.proj3d"><tt class="docutils literal"><span class="pre">proj3d</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="tutorial.html"
title="previous chapter">mplot3d tutorial</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="faq.html"
title="next chapter">mplot3d FAQ</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/mpl_toolkits/mplot3d/api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<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="mplot3d-api">
<span id="toolkit-mplot3d-api"></span><h1>mplot3d API<a class="headerlink" href="#mplot3d-api" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#mplot3d-api" id="id1">mplot3d API</a><ul>
<li><a class="reference internal" href="#axes3d" id="id2"><a class="reference internal" href="#module-mpl_toolkits.mplot3d.axes3d" title="mpl_toolkits.mplot3d.axes3d"><tt class="xref py py-mod docutils literal"><span class="pre">axes3d</span></tt></a></a></li>
<li><a class="reference internal" href="#axis3d" id="id3"><a class="reference internal" href="#module-mpl_toolkits.mplot3d.axis3d" title="mpl_toolkits.mplot3d.axis3d"><tt class="xref py py-mod docutils literal"><span class="pre">axis3d</span></tt></a></a></li>
<li><a class="reference internal" href="#module-mpl_toolkits.mplot3d.art3d" id="id4"><a class="reference internal" href="#module-mpl_toolkits.mplot3d.art3d" title="mpl_toolkits.mplot3d.art3d"><tt class="xref py py-mod docutils literal"><span class="pre">art3d</span></tt></a></a></li>
<li><a class="reference internal" href="#module-mpl_toolkits.mplot3d.proj3d" id="id5"><a class="reference internal" href="#module-mpl_toolkits.mplot3d.proj3d" title="mpl_toolkits.mplot3d.proj3d"><tt class="xref py py-mod docutils literal"><span class="pre">proj3d</span></tt></a></a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="axes3d">
<span id="toolkit-mplot3d-axesapi"></span><h2><a class="reference internal" href="#module-mpl_toolkits.mplot3d.axes3d" title="mpl_toolkits.mplot3d.axes3d"><tt class="xref py py-mod docutils literal"><span class="pre">axes3d</span></tt></a><a class="headerlink" href="#axes3d" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Significant effort went into bringing axes3d to feature-parity with
regular axes objects for version 1.1.0. However, more work remains.
Please report any functions that do not behave as expected as a bug.
In addition, help and patches would be greatly appreciated!</p>
</div>
<span class="target" id="module-mpl_toolkits.mplot3d.axes3d"></span><p>Module containing Axes3D, an object which can plot 3D objects on a
2D matplotlib figure.</p>
<dl class="class">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D">
<em class="property">class </em><tt class="descclassname">mpl_toolkits.mplot3d.axes3d.</tt><tt class="descname">Axes3D</tt><span class="sig-paren">(</span><em>fig</em>, <em>rect=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">matplotlib.axes._axes.Axes</span></tt></p>
<p>3D axes object.</p>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.add_collection3d">
<tt class="descname">add_collection3d</tt><span class="sig-paren">(</span><em>col</em>, <em>zs=0</em>, <em>zdir=u'z'</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.add_collection3d" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a 3D collection object to the plot.</p>
<p>2D collection types are converted to a 3D version by
modifying the object and adding z coordinate information.</p>
<dl class="docutils">
<dt>Supported are:</dt>
<dd><ul class="first last simple">
<li>PolyCollection</li>
<li>LineColleciton</li>
<li>PatchCollection</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.add_contour_set">
<tt class="descname">add_contour_set</tt><span class="sig-paren">(</span><em>cset</em>, <em>extend3d=False</em>, <em>stride=5</em>, <em>zdir=u'z'</em>, <em>offset=None</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.add_contour_set" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.add_contourf_set">
<tt class="descname">add_contourf_set</tt><span class="sig-paren">(</span><em>cset</em>, <em>zdir=u'z'</em>, <em>offset=None</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.add_contourf_set" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.auto_scale_xyz">
<tt class="descname">auto_scale_xyz</tt><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z=None</em>, <em>had_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.auto_scale_xyz" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.autoscale">
<tt class="descname">autoscale</tt><span class="sig-paren">(</span><em>enable=True</em>, <em>axis=u'both'</em>, <em>tight=None</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience method for simple axis view autoscaling.
See <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.autoscale" title="matplotlib.axes.Axes.autoscale"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.autoscale()</span></tt></a> for full explanation.
Note that this function behaves the same, but for all
three axes. Therfore, ‘z’ can be passed for <em>axis</em>,
and ‘both’ applies to all three axes.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.autoscale_view">
<tt class="descname">autoscale_view</tt><span class="sig-paren">(</span><em>tight=None</em>, <em>scalex=True</em>, <em>scaley=True</em>, <em>scalez=True</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.autoscale_view" title="Permalink to this definition">¶</a></dt>
<dd><p>Autoscale the view limits using the data limits.
See <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.autoscale_view" title="matplotlib.axes.Axes.autoscale_view"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.autoscale_view()</span></tt></a> for documentation.
Note that this function applies to the 3D axes, and as such
adds the <em>scalez</em> to the function arguments.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>Function signature was changed to better match the 2D version.
<em>tight</em> is now explicitly a kwarg and placed first.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.2.1: </span>This is now fully functional.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.bar">
<tt class="descname">bar</tt><span class="sig-paren">(</span><em>left</em>, <em>height</em>, <em>zs=0</em>, <em>zdir=u'z'</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.bar" title="Permalink to this definition">¶</a></dt>
<dd><p>Add 2D bar(s).</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>left</em></td>
<td>The x coordinates of the left sides of the bars.</td>
</tr>
<tr class="row-odd"><td><em>height</em></td>
<td>The height of the bars.</td>
</tr>
<tr class="row-even"><td><em>zs</em></td>
<td>Z coordinate of bars, if one value is specified
they will all be placed at the same z.</td>
</tr>
<tr class="row-odd"><td><em>zdir</em></td>
<td>Which direction to use as z (‘x’, ‘y’ or ‘z’)
when plotting a 2D set.</td>
</tr>
</tbody>
</table>
<p>Keyword arguments are passed onto <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><tt class="xref py py-func docutils literal"><span class="pre">bar()</span></tt></a>.</p>
<p>Returns a <a class="reference internal" href="#mpl_toolkits.mplot3d.art3d.Patch3DCollection" title="mpl_toolkits.mplot3d.art3d.Patch3DCollection"><tt class="xref py py-class docutils literal"><span class="pre">Patch3DCollection</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.bar3d">
<tt class="descname">bar3d</tt><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>z</em>, <em>dx</em>, <em>dy</em>, <em>dz</em>, <em>color=u'b'</em>, <em>zsort=u'average'</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.bar3d" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a 3D bar, or multiple bars.</p>
<p>When generating multiple bars, x, y, z have to be arrays.
dx, dy, dz can be arrays or scalars.</p>
<p><em>color</em> can be:</p>
<blockquote>
<div><ul class="simple">
<li>A single color value, to color all bars the same color.</li>
<li>An array of colors of length N bars, to color each bar
independently.</li>
<li>An array of colors of length 6, to color the faces of the
bars similarly.</li>
<li>An array of colors of length 6 * N bars, to color each face
independently.</li>
</ul>
<p>When coloring the faces of the boxes specifically, this is
the order of the coloring:</p>
<blockquote>
<div><ol class="arabic simple">
<li>-Z (bottom of box)</li>
<li>+Z (top of box)</li>
<li>-Y</li>
<li>+Y</li>
<li>-X</li>
<li>+X</li>
</ol>
</div></blockquote>
</div></blockquote>
<p>Keyword arguments are passed onto
<a class="reference internal" href="#mpl_toolkits.mplot3d.art3d.Poly3DCollection" title="mpl_toolkits.mplot3d.art3d.Poly3DCollection"><tt class="xref py py-func docutils literal"><span class="pre">Poly3DCollection()</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.can_pan">
<tt class="descname">can_pan</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.can_pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the pan/zoom button functionality.</p>
<p>3D axes objects do not use the pan/zoom button.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.can_zoom">
<tt class="descname">can_zoom</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.can_zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the zoom box button functionality.</p>
<p>3D axes objects do not use the zoom box button.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.cla">
<tt class="descname">cla</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.cla" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear axes</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.clabel">
<tt class="descname">clabel</tt><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.clabel" title="Permalink to this definition">¶</a></dt>
<dd><p>This function is currently not implemented for 3D axes.
Returns <em>None</em>.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.contour">
<tt class="descname">contour</tt><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.contour" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a 3D contour plot.</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>,</td>
<td>Data values as numpy.arrays</td>
</tr>
<tr class="row-odd"><td><em>Z</em></td>
<td> </td>
</tr>
<tr class="row-even"><td><em>extend3d</em></td>
<td>Whether to extend contour in 3D (default: False)</td>
</tr>
<tr class="row-odd"><td><em>stride</em></td>
<td>Stride (step size) for extending contour</td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>The direction to use: x, y or z (default)</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>If specified plot a projection of the contour
lines on this position in plane normal to zdir</td>
</tr>
</tbody>
</table>
<p>The positional and other keyword arguments are passed on to
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><tt class="xref py py-func docutils literal"><span class="pre">contour()</span></tt></a></p>
<p>Returns a <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><tt class="xref py py-class docutils literal"><span class="pre">contour</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.contour3D">
<tt class="descname">contour3D</tt><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.contour3D" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a 3D contour plot.</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>,</td>
<td>Data values as numpy.arrays</td>
</tr>
<tr class="row-odd"><td><em>Z</em></td>
<td> </td>
</tr>
<tr class="row-even"><td><em>extend3d</em></td>
<td>Whether to extend contour in 3D (default: False)</td>
</tr>
<tr class="row-odd"><td><em>stride</em></td>
<td>Stride (step size) for extending contour</td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>The direction to use: x, y or z (default)</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>If specified plot a projection of the contour
lines on this position in plane normal to zdir</td>
</tr>
</tbody>
</table>
<p>The positional and other keyword arguments are passed on to
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><tt class="xref py py-func docutils literal"><span class="pre">contour()</span></tt></a></p>
<p>Returns a <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><tt class="xref py py-class docutils literal"><span class="pre">contour</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.contourf">
<tt class="descname">contourf</tt><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.contourf" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a 3D contourf plot.</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="84%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>,</td>
<td>Data values as numpy.arrays</td>
</tr>
<tr class="row-odd"><td><em>Z</em></td>
<td> </td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>The direction to use: x, y or z (default)</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>If specified plot a projection of the filled contour
on this position in plane normal to zdir</td>
</tr>
</tbody>
</table>
<p>The positional and keyword arguments are passed on to
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contourf" title="matplotlib.axes.Axes.contourf"><tt class="xref py py-func docutils literal"><span class="pre">contourf()</span></tt></a></p>
<p>Returns a <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contourf" title="matplotlib.axes.Axes.contourf"><tt class="xref py py-class docutils literal"><span class="pre">contourf</span></tt></a></p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>The <em>zdir</em> and <em>offset</em> kwargs were added.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.contourf3D">
<tt class="descname">contourf3D</tt><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.contourf3D" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a 3D contourf plot.</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="84%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>,</td>
<td>Data values as numpy.arrays</td>
</tr>
<tr class="row-odd"><td><em>Z</em></td>
<td> </td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>The direction to use: x, y or z (default)</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>If specified plot a projection of the filled contour
on this position in plane normal to zdir</td>
</tr>
</tbody>
</table>
<p>The positional and keyword arguments are passed on to
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contourf" title="matplotlib.axes.Axes.contourf"><tt class="xref py py-func docutils literal"><span class="pre">contourf()</span></tt></a></p>
<p>Returns a <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.contourf" title="matplotlib.axes.Axes.contourf"><tt class="xref py py-class docutils literal"><span class="pre">contourf</span></tt></a></p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>The <em>zdir</em> and <em>offset</em> kwargs were added.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.convert_zunits">
<tt class="descname">convert_zunits</tt><span class="sig-paren">(</span><em>z</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.convert_zunits" title="Permalink to this definition">¶</a></dt>
<dd><p>For artists in an axes, if the zaxis has units support,
convert <em>z</em> using zaxis unit type</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.1.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.disable_mouse_rotation">
<tt class="descname">disable_mouse_rotation</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.disable_mouse_rotation" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable mouse button callbacks.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.draw">
<tt class="descname">draw</tt><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.format_coord">
<tt class="descname">format_coord</tt><span class="sig-paren">(</span><em>xd</em>, <em>yd</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.format_coord" title="Permalink to this definition">¶</a></dt>
<dd><p>Given the 2D view coordinates attempt to guess a 3D coordinate.
Looks for the nearest edge to the point and then assumes that
the point is at the same z location as the nearest point on the edge.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.format_zdata">
<tt class="descname">format_zdata</tt><span class="sig-paren">(</span><em>z</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.format_zdata" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>z</em> string formatted. This function will use the
<tt class="xref py py-attr docutils literal"><span class="pre">fmt_zdata</span></tt> attribute if it is callable, else will fall
back on the zaxis major formatter</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_autoscale_on">
<tt class="descname">get_autoscale_on</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_autoscale_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Get whether autoscaling is applied for all axes on plot commands</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_autoscalez_on">
<tt class="descname">get_autoscalez_on</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_autoscalez_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Get whether autoscaling for the z-axis is applied on plot commands</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_axis_position">
<tt class="descname">get_axis_position</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_axis_position" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_axisbelow">
<tt class="descname">get_axisbelow</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_axisbelow" title="Permalink to this definition">¶</a></dt>
<dd><p>Get whether axis below is true or not.</p>
<p>For axes3d objects, this will always be <em>True</em></p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added for completeness.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_children">
<tt class="descname">get_children</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_frame_on">
<tt class="descname">get_frame_on</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_frame_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Get whether the 3D axes panels are drawn</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_proj">
<tt class="descname">get_proj</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_proj" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the projection matrix from the current viewing position.</p>
<p>elev stores the elevation angle in the z plane
azim stores the azimuth angle in the x,y plane</p>
<p>dist is the distance of the eye viewing point from the object
point.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_w_lims">
<tt class="descname">get_w_lims</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_w_lims" title="Permalink to this definition">¶</a></dt>
<dd><p>Get 3D world limits.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_xlim">
<tt class="descname">get_xlim</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_xlim" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the x-axis range [<em>left</em>, <em>right</em>]</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>This function now correctly refers to the 3D x-limits</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_xlim3d">
<tt class="descname">get_xlim3d</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_xlim3d" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the x-axis range [<em>left</em>, <em>right</em>]</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>This function now correctly refers to the 3D x-limits</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim">
<tt class="descname">get_ylim</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the y-axis range [<em>bottom</em>, <em>top</em>]</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>This function now correctly refers to the 3D y-limits.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d">
<tt class="descname">get_ylim3d</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the y-axis range [<em>bottom</em>, <em>top</em>]</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>This function now correctly refers to the 3D y-limits.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zbound">
<tt class="descname">get_zbound</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zbound" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the z-axis numerical bounds where:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">lowerBound</span> <span class="o"><</span> <span class="n">upperBound</span>
</pre></div>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zlabel">
<tt class="descname">get_zlabel</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zlabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the z-label text string.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zlim">
<tt class="descname">get_zlim</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zlim" title="Permalink to this definition">¶</a></dt>
<dd><p>Get 3D z limits.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zlim3d">
<tt class="descname">get_zlim3d</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zlim3d" title="Permalink to this definition">¶</a></dt>
<dd><p>Get 3D z limits.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zmajorticklabels">
<tt class="descname">get_zmajorticklabels</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zmajorticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ztick labels as a list of Text instances</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zminorticklabels">
<tt class="descname">get_zminorticklabels</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zminorticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ztick labels as a list of Text instances</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Minor ticks are not supported. This function was added
only for completeness.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zscale">
<tt class="descname">get_zscale</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zscale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zticklabels">
<tt class="descname">get_zticklabels</tt><span class="sig-paren">(</span><em>minor=False</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Get ztick labels as a list of Text instances.
See <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.get_yticklabels" title="matplotlib.axes.Axes.get_yticklabels"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.get_yticklabels()</span></tt></a> for more details.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Minor ticks are not supported.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zticklines">
<tt class="descname">get_zticklines</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Get ztick lines as a list of Line2D instances.
Note that this function is provided merely for completeness.
These lines are re-calculated as the display changes.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.get_zticks">
<tt class="descname">get_zticks</tt><span class="sig-paren">(</span><em>minor=False</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.get_zticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the z ticks as a list of locations
See <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.get_yticks" title="matplotlib.axes.Axes.get_yticks"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.get_yticks()</span></tt></a> for more details.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Minor ticks are not supported.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.grid">
<tt class="descname">grid</tt><span class="sig-paren">(</span><em>b=True</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Set / unset 3D grid.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Currently, this function does not behave the same as
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.grid" title="matplotlib.axes.Axes.grid"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.grid()</span></tt></a>, but it is intended to
eventually support that behavior.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>This function was changed, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.have_units">
<tt class="descname">have_units</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.have_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if units are set on the <em>x</em>, <em>y</em>, or <em>z</em> axes</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.invert_zaxis">
<tt class="descname">invert_zaxis</tt><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.invert_zaxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Invert the z-axis.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.locator_params">
<tt class="descname">locator_params</tt><span class="sig-paren">(</span><em>axis=u'both'</em>, <em>tight=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.locator_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience method for controlling tick locators.</p>
<p>See <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.locator_params" title="matplotlib.axes.Axes.locator_params"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.locator_params()</span></tt></a> for full
documentation Note that this is for Axes3D objects,
therefore, setting <em>axis</em> to ‘both’ will result in the
parameters being set for all three axes. Also, <em>axis</em>
can also take a value of ‘z’ to apply parameters to the
z axis.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.margins">
<tt class="descname">margins</tt><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.margins" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience method to set or retrieve autoscaling margins.</p>
<dl class="docutils">
<dt>signatures::</dt>
<dd>margins()</dd>
</dl>
<p>returns xmargin, ymargin, zmargin</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">margins</span><span class="p">(</span><span class="n">margin</span><span class="p">)</span>
<span class="n">margins</span><span class="p">(</span><span class="n">xmargin</span><span class="p">,</span> <span class="n">ymargin</span><span class="p">,</span> <span class="n">zmargin</span><span class="p">)</span>
<span class="n">margins</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">xmargin</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="n">ymargin</span><span class="p">,</span> <span class="n">z</span><span class="o">=</span><span class="n">zmargin</span><span class="p">)</span>
<span class="n">margins</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">tight</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
</pre></div>
</div>
<p>All forms above set the xmargin, ymargin and zmargin
parameters. All keyword parameters are optional. A single argument
specifies xmargin, ymargin and zmargin. The <em>tight</em> parameter
is passed to <a class="reference internal" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.autoscale_view" title="mpl_toolkits.mplot3d.axes3d.Axes3D.autoscale_view"><tt class="xref py py-meth docutils literal"><span class="pre">autoscale_view()</span></tt></a>, which is executed after
a margin is changed; the default here is <em>True</em>, on the
assumption that when margins are specified, no additional
padding to match tick marks is usually desired. Setting
<em>tight</em> to <em>None</em> will preserve the previous setting.</p>
<p>Specifying any margin changes only the autoscaling; for example,
if <em>xmargin</em> is not None, then <em>xmargin</em> times the X data
interval will be added to each end of that interval before
it is used in autoscaling.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>This function was added, but not tested. Please report any bugs.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.mouse_init">
<tt class="descname">mouse_init</tt><span class="sig-paren">(</span><em>rotate_btn=1</em>, <em>zoom_btn=3</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.mouse_init" title="Permalink to this definition">¶</a></dt>
<dd><p>Initializes mouse button callbacks to enable 3D rotation of
the axes. Also optionally sets the mouse buttons for 3D rotation
and zooming.</p>
<table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="82%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>rotate_btn</em></td>
<td>The integer or list of integers specifying which mouse
button or buttons to use for 3D rotation of the axes.
Default = 1.</td>
</tr>
<tr class="row-odd"><td><em>zoom_btn</em></td>
<td>The integer or list of integers specifying which mouse
button or buttons to use to zoom the 3D axes.
Default = 3.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.name">
<tt class="descname">name</tt><em class="property"> = u'3d'</em><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.plot">
<tt class="descname">plot</tt><span class="sig-paren">(</span><em>xs</em>, <em>ys</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.plot" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot 2D or 3D data.</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>xs</em>, <em>ys</em></td>
<td>X, y coordinates of vertices</td>
</tr>
<tr class="row-odd"><td><em>zs</em></td>
<td>z value(s), either one for all points or one for
each point.</td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>Which direction to use as z (‘x’, ‘y’ or ‘z’)
when plotting a 2D set.</td>
</tr>
</tbody>
</table>
<p>Other arguments are passed on to
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><tt class="xref py py-func docutils literal"><span class="pre">plot()</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.plot3D">
<tt class="descname">plot3D</tt><span class="sig-paren">(</span><em>xs</em>, <em>ys</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.plot3D" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot 2D or 3D data.</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>xs</em>, <em>ys</em></td>
<td>X, y coordinates of vertices</td>
</tr>
<tr class="row-odd"><td><em>zs</em></td>
<td>z value(s), either one for all points or one for
each point.</td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>Which direction to use as z (‘x’, ‘y’ or ‘z’)
when plotting a 2D set.</td>
</tr>
</tbody>
</table>
<p>Other arguments are passed on to
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><tt class="xref py py-func docutils literal"><span class="pre">plot()</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface">
<tt class="descname">plot_surface</tt><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a surface plot.</p>
<p>By default it will be colored in shades of a solid color,
but it also supports color mapping by supplying the <em>cmap</em>
argument.</p>
<p>The <tt class="xref py py-obj docutils literal"><span class="pre">rstride</span></tt> and <tt class="xref py py-obj docutils literal"><span class="pre">cstride</span></tt> kwargs set the stride used to
sample the input data to generate the graph. If 1k by 1k
arrays are passed in the default values for the strides will
result in a 100x100 grid being plotted.</p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>, <em>Z</em></td>
<td>Data values as 2D arrays</td>
</tr>
<tr class="row-odd"><td><em>rstride</em></td>
<td>Array row stride (step size), defaults to 10</td>
</tr>
<tr class="row-even"><td><em>cstride</em></td>
<td>Array column stride (step size), defaults to 10</td>
</tr>
<tr class="row-odd"><td><em>color</em></td>
<td>Color of the surface patches</td>
</tr>
<tr class="row-even"><td><em>cmap</em></td>
<td>A colormap for the surface patches.</td>
</tr>
<tr class="row-odd"><td><em>facecolors</em></td>
<td>Face colors for the individual patches</td>
</tr>
<tr class="row-even"><td><em>norm</em></td>
<td>An instance of Normalize to map values to colors</td>
</tr>
<tr class="row-odd"><td><em>vmin</em></td>
<td>Minimum value to map</td>
</tr>
<tr class="row-even"><td><em>vmax</em></td>
<td>Maximum value to map</td>
</tr>
<tr class="row-odd"><td><em>shade</em></td>
<td>Whether to shade the facecolors</td>
</tr>
</tbody>
</table>
<p>Other arguments are passed on to
<a class="reference internal" href="#mpl_toolkits.mplot3d.art3d.Poly3DCollection" title="mpl_toolkits.mplot3d.art3d.Poly3DCollection"><tt class="xref py py-class docutils literal"><span class="pre">Poly3DCollection</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf">
<tt class="descname">plot_trisurf</tt><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf" title="Permalink to this definition">¶</a></dt>
<dd><table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>, <em>Z</em></td>
<td>Data values as 1D arrays</td>
</tr>
<tr class="row-odd"><td><em>color</em></td>
<td>Color of the surface patches</td>
</tr>
<tr class="row-even"><td><em>cmap</em></td>
<td>A colormap for the surface patches.</td>
</tr>
<tr class="row-odd"><td><em>norm</em></td>
<td>An instance of Normalize to map values to colors</td>
</tr>
<tr class="row-even"><td><em>vmin</em></td>
<td>Minimum value to map</td>
</tr>
<tr class="row-odd"><td><em>vmax</em></td>
<td>Maximum value to map</td>
</tr>
<tr class="row-even"><td><em>shade</em></td>
<td>Whether to shade the facecolors</td>
</tr>
</tbody>
</table>
<p>The (optional) triangulation can be specified in one of two ways;
either:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">plot_trisurf</span><span class="p">(</span><span class="n">triangulation</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
</pre></div>
</div>
<p>where triangulation is a <a class="reference internal" href="../../api/tri_api.html#matplotlib.tri.Triangulation" title="matplotlib.tri.Triangulation"><tt class="xref py py-class docutils literal"><span class="pre">Triangulation</span></tt></a>
object, or:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">plot_trisurf</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
<span class="n">plot_trisurf</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">triangles</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
<span class="n">plot_trisurf</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">triangles</span><span class="o">=</span><span class="n">triangles</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
</pre></div>