Repository navigation
Expand file tree
/
Copy pathaxes_api.rst
More file actions
624 lines (452 loc) · 9.11 KB
/
Copy pathaxes_api.rst
File metadata and controls
624 lines (452 loc) · 9.11 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
*******************
``matplotlib.axes``
*******************
The `~.axes.Axes` class represents one (sub-)plot in a figure. It contains the
plotted data, axis ticks, labels, title, legend, etc. Its methods are the main
interface for manipulating the plot.
.. currentmodule:: matplotlib.axes
.. contents:: Table of Contents
:depth: 2
:local:
:backlinks: entry
:class: multicol-toc
.. automodule:: matplotlib.axes
:no-members:
:no-undoc-members:
The Axes class
==============
.. autosummary::
:toctree: _as_gen
:template: autosummary_class_only.rst
:nosignatures:
Axes
Attributes
----------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.viewLim
Axes.dataLim
Plotting
========
Basic
-----
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.plot
Axes.errorbar
Axes.scatter
Axes.plot_date
Axes.step
Axes.loglog
Axes.semilogx
Axes.semilogy
Axes.fill_between
Axes.fill_betweenx
Axes.bar
Axes.barh
Axes.bar_label
Axes.stem
Axes.eventplot
Axes.pie
Axes.stackplot
Axes.broken_barh
Axes.vlines
Axes.hlines
Axes.fill
Spans
-----
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.axhline
Axes.axhspan
Axes.axvline
Axes.axvspan
Axes.axline
Spectral
--------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.acorr
Axes.angle_spectrum
Axes.cohere
Axes.csd
Axes.magnitude_spectrum
Axes.phase_spectrum
Axes.psd
Axes.specgram
Axes.xcorr
Statistics
----------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.ecdf
Axes.boxplot
Axes.violinplot
Axes.bxp
Axes.violin
Binned
------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.hexbin
Axes.hist
Axes.hist2d
Axes.stairs
Contours
--------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.clabel
Axes.contour
Axes.contourf
2D arrays
---------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.imshow
Axes.matshow
Axes.pcolor
Axes.pcolorfast
Axes.pcolormesh
Axes.spy
Unstructured triangles
----------------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.tripcolor
Axes.triplot
Axes.tricontour
Axes.tricontourf
Text and annotations
--------------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.annotate
Axes.text
Axes.table
Axes.arrow
Axes.inset_axes
Axes.indicate_inset
Axes.indicate_inset_zoom
Axes.secondary_xaxis
Axes.secondary_yaxis
Vector fields
-------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.barbs
Axes.quiver
Axes.quiverkey
Axes.streamplot
Clearing
========
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.cla
Axes.clear
Appearance
==========
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.axis
Axes.set_axis_off
Axes.set_axis_on
Axes.set_frame_on
Axes.get_frame_on
Axes.set_axisbelow
Axes.get_axisbelow
Axes.grid
Axes.get_facecolor
Axes.set_facecolor
Property cycle
==============
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.set_prop_cycle
Axis / limits
=============
.. For families of methods of the form {get,set}_{x,y}foo, try to list them in
the order set_xfoo, get_xfoo, set_yfoo, get_yfoo
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.get_xaxis
Axes.get_yaxis
Axis limits and direction
-------------------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.set_xinverted
Axes.get_xinverted
Axes.invert_xaxis
Axes.xaxis_inverted
Axes.set_yinverted
Axes.get_yinverted
Axes.invert_yaxis
Axes.yaxis_inverted
Axes.set_xlim
Axes.get_xlim
Axes.set_ylim
Axes.get_ylim
Axes.update_datalim
Axes.set_xbound
Axes.get_xbound
Axes.set_ybound
Axes.get_ybound
Axis labels, title, and legend
------------------------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.set_xlabel
Axes.get_xlabel
Axes.set_ylabel
Axes.get_ylabel
Axes.label_outer
Axes.set_title
Axes.get_title
Axes.legend
Axes.get_legend
Axes.get_legend_handles_labels
Axis scales
-----------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.set_xscale
Axes.get_xscale
Axes.set_yscale
Axes.get_yscale
Autoscaling and margins
-----------------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.use_sticky_edges
Axes.margins
Axes.get_xmargin
Axes.get_ymargin
Axes.set_xmargin
Axes.set_ymargin
Axes.relim
Axes.autoscale
Axes.autoscale_view
Axes.set_autoscale_on
Axes.get_autoscale_on
Axes.set_autoscalex_on
Axes.get_autoscalex_on
Axes.set_autoscaley_on
Axes.get_autoscaley_on
Aspect ratio
------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.apply_aspect
Axes.set_aspect
Axes.get_aspect
Axes.set_box_aspect
Axes.get_box_aspect
Axes.set_adjustable
Axes.get_adjustable
Ticks and tick labels
---------------------
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.set_xticks
Axes.get_xticks
Axes.set_xticklabels
Axes.get_xticklabels
Axes.get_xmajorticklabels
Axes.get_xminorticklabels
Axes.get_xgridlines
Axes.get_xticklines
Axes.xaxis_date
Axes.set_yticks
Axes.get_yticks
Axes.set_yticklabels
Axes.get_yticklabels
Axes.get_ymajorticklabels
Axes.get_yminorticklabels
Axes.get_ygridlines
Axes.get_yticklines
Axes.yaxis_date
Axes.minorticks_off
Axes.minorticks_on
Axes.ticklabel_format
Axes.tick_params
Axes.locator_params
Units
=====
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.convert_xunits
Axes.convert_yunits
Axes.have_units
Adding artists
==============
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.add_artist
Axes.add_child_axes
Axes.add_collection
Axes.add_container
Axes.add_image
Axes.add_line
Axes.add_patch
Axes.add_table
Twinning and sharing
====================
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.twinx
Axes.twiny
Axes.sharex
Axes.sharey
Axes.get_shared_x_axes
Axes.get_shared_y_axes
Axes position
=============
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.get_anchor
Axes.set_anchor
Axes.get_axes_locator
Axes.set_axes_locator
Axes.get_subplotspec
Axes.set_subplotspec
Axes.reset_position
Axes.get_position
Axes.set_position
Async/event based
=================
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.stale
Axes.pchanged
Axes.add_callback
Axes.remove_callback
Interactive
===========
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.can_pan
Axes.can_zoom
Axes.get_navigate
Axes.set_navigate
Axes.get_navigate_mode
Axes.set_navigate_mode
Axes.get_forward_navigation_events
Axes.set_forward_navigation_events
Axes.start_pan
Axes.drag_pan
Axes.end_pan
Axes.format_coord
Axes.format_cursor_data
Axes.format_xdata
Axes.format_ydata
Axes.mouseover
Axes.in_axes
Axes.contains
Axes.contains_point
Axes.get_cursor_data
Children
========
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.get_children
Axes.get_images
Axes.get_lines
Axes.findobj
Drawing
=======
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.draw
Axes.draw_artist
Axes.redraw_in_frame
Axes.get_rasterization_zorder
Axes.set_rasterization_zorder
Axes.get_window_extent
Axes.get_tightbbox
Projection
==========
Methods used by `~matplotlib.axis.Axis` that must be overridden for
non-rectilinear Axes.
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.name
Axes.get_xaxis_transform
Axes.get_yaxis_transform
Axes.get_data_ratio
Axes.get_xaxis_text1_transform
Axes.get_xaxis_text2_transform
Axes.get_yaxis_text1_transform
Axes.get_yaxis_text2_transform
Other
=====
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:
Axes.zorder
Axes.get_default_bbox_extra_artists
Axes.get_transformed_clip_path_and_affine
Axes.has_data
Axes.set
.. autoclass:: matplotlib.axes.Axes.ArtistList