Skip to content
Navigation Menu
{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 8.4k
Expand file tree
/
Copy pathaxis.py
More file actions
2986 lines (2549 loc) · 109 KB
/
Copy pathaxis.py
File metadata and controls
2986 lines (2549 loc) · 109 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
"""
Classes for the ticks and x- and y-axis.
"""
import datetime
import functools
import logging
from numbers import Real
import warnings
import numpy as np
import matplotlib as mpl
from matplotlib import _api, cbook
import matplotlib.artist as martist
import matplotlib.colors as mcolors
import matplotlib.lines as mlines
import matplotlib.scale as mscale
import matplotlib.text as mtext
import matplotlib.ticker as mticker
import matplotlib.transforms as mtransforms
import matplotlib.units as munits
from matplotlib.ticker import NullLocator
_log = logging.getLogger(__name__)
GRIDLINE_INTERPOLATION_STEPS = 180
# This list is being used for compatibility with Axes.grid, which
# allows all Line2D kwargs.
_line_inspector = martist.ArtistInspector(mlines.Line2D)
_line_param_names = _line_inspector.get_setters()
_line_param_aliases = [next(iter(d)) for d in _line_inspector.aliasd.values()]
_gridline_param_names = ['grid_' + name
for name in _line_param_names + _line_param_aliases]
class Tick(martist.Artist):
"""
Abstract base class for the axis ticks, grid lines and labels.
Ticks mark a position on an Axis. They contain two lines as markers and
two labels; one each for the bottom and top positions (in case of an
`.XAxis`) or for the left and right positions (in case of a `.YAxis`).
Attributes
----------
tick1line : `~matplotlib.lines.Line2D`
The left/bottom tick marker.
tick2line : `~matplotlib.lines.Line2D`
The right/top tick marker.
gridline : `~matplotlib.lines.Line2D`
The grid line associated with the label position.
label1 : `~matplotlib.text.Text`
The left/bottom tick label.
label2 : `~matplotlib.text.Text`
The right/top tick label.
Notes
-----
Ticks are managed though the autoscaling / view limit mechanism and therefore
need very careful handling when explicitly accessed, see :ref:`axes-tick-objects`.
The tick lines are implemented as `~matplotlib.lines.Line2D` instances using the
`~.matplotlib.markers` TICKLEFT, TICKRIGHT, TICKDOWN, TICKUP. Therefore,
properties are controlled via the marker, e.g. for the color
`.Line2D.set_markeredgecolor` and not `.Line2D.set_color`.
"""
def __init__(
self, axes, loc, *,
size=None, # points
width=None,
color=None,
tickdir=None,
pad=None,
labelsize=None,
labelcolor=None,
labelfontfamily=None,
zorder=None,
gridOn=None, # defaults to axes.grid depending on axes.grid.which
tick1On=True,
tick2On=True,
label1On=True,
label2On=False,
major=True,
labelrotation=0,
labelrotation_mode=None,
grid_color=None,
grid_linestyle=None,
grid_linewidth=None,
grid_alpha=None,
**kwargs, # Other Line2D kwargs applied to gridlines.
):
"""
Parameters
----------
loc
The tick location in data coords.
size
The tick size in points.
"""
super().__init__()
if gridOn is None:
which = mpl.rcParams['axes.grid.which']
if major and which in ('both', 'major'):
gridOn = mpl.rcParams['axes.grid']
elif not major and which in ('both', 'minor'):
gridOn = mpl.rcParams['axes.grid']
else:
gridOn = False
self.set_figure(axes.get_figure(root=False))
self.axes = axes
self._loc = loc
self._major = major
name = self.__name__
major_minor = "major" if major else "minor"
self._size = mpl._val_or_rc(size, f"{name}.{major_minor}.size")
self._width = mpl._val_or_rc(width, f"{name}.{major_minor}.width")
self._base_pad = mpl._val_or_rc(pad, f"{name}.{major_minor}.pad")
color = mpl._val_or_rc(color, f"{name}.color")
labelcolor = mpl._val_or_rc(labelcolor, f"{name}.labelcolor")
if cbook._str_equal(labelcolor, 'inherit'):
# inherit from tick color
labelcolor = mpl.rcParams[f"{name}.color"]
labelsize = mpl._val_or_rc(labelsize, f"{name}.labelsize")
self._set_labelrotation(labelrotation)
if zorder is None:
if major:
zorder = mlines.Line2D.zorder + 0.01
else:
zorder = mlines.Line2D.zorder
self._zorder = zorder
grid_color = mpl._val_or_rc(
grid_color,
f"grid.{major_minor}.color",
"grid.color",
)
grid_linestyle = mpl._val_or_rc(
grid_linestyle,
f"grid.{major_minor}.linestyle",
"grid.linestyle",
)
grid_linewidth = mpl._val_or_rc(
grid_linewidth,
f"grid.{major_minor}.linewidth",
"grid.linewidth",
)
if grid_alpha is None:
if mcolors._has_alpha_channel(grid_color):
# Extract alpha from the color
# alpha precedence: kwarg > color alpha > rcParams['grid.alpha']
rgba = mcolors.to_rgba(grid_color)
grid_color = rgba[:3] # RGB only
grid_alpha = rgba[3] # Alpha from color
else:
# No alpha in color, use rcParams
grid_alpha = mpl._val_or_rc(
# grid_alpha is None so we can use the first key
mpl.rcParams[f"grid.{major_minor}.alpha"],
"grid.alpha",
)
grid_kw = {k[5:]: v for k, v in kwargs.items() if k != "rotation_mode"}
self.tick1line = mlines.Line2D(
[], [],
color=color, linestyle="none", zorder=zorder, visible=tick1On,
markeredgecolor=color, markersize=self._size, markeredgewidth=self._width,
)
self.tick2line = mlines.Line2D(
[], [],
color=color, linestyle="none", zorder=zorder, visible=tick2On,
markeredgecolor=color, markersize=self._size, markeredgewidth=self._width,
)
self.gridline = mlines.Line2D(
[], [],
color=grid_color, alpha=grid_alpha, visible=gridOn,
linestyle=grid_linestyle, linewidth=grid_linewidth, marker="",
**grid_kw,
)
self.gridline.get_path()._interpolation_steps = \
GRIDLINE_INTERPOLATION_STEPS
self.label1 = mtext.Text(
np.nan, np.nan,
fontsize=labelsize, color=labelcolor, visible=label1On,
fontfamily=labelfontfamily, rotation=self._labelrotation[1],
rotation_mode=labelrotation_mode)
self.label2 = mtext.Text(
np.nan, np.nan,
fontsize=labelsize, color=labelcolor, visible=label2On,
fontfamily=labelfontfamily, rotation=self._labelrotation[1],
rotation_mode=labelrotation_mode)
self._apply_tickdir(tickdir)
for artist in [self.tick1line, self.tick2line, self.gridline,
self.label1, self.label2]:
self._set_artist_props(artist)
self.update_position(loc)
def _set_labelrotation(self, labelrotation):
if isinstance(labelrotation, str):
mode = labelrotation
angle = 0
elif isinstance(labelrotation, (tuple, list)):
mode, angle = labelrotation
else:
mode = 'default'
angle = labelrotation
_api.check_in_list(['auto', 'default'], labelrotation=mode)
self._labelrotation = (mode, angle)
@property
def _pad(self):
return self._base_pad + self.get_tick_padding()
def _apply_tickdir(self, tickdir):
"""Set tick direction. Valid values are 'out', 'in', 'inout'."""
# This method is responsible for verifying input and, in subclasses, for setting
# the tick{1,2}line markers. From the user perspective this should always be
# called through _apply_params, which further updates ticklabel positions using
# the new pads.
tickdir = mpl._val_or_rc(tickdir, f'{self.__name__}.direction')
_api.check_in_list(['in', 'out', 'inout'], tickdir=tickdir)
self._tickdir = tickdir
def get_tickdir(self):
return self._tickdir
def get_tick_padding(self):
"""Get the length of the tick outside of the Axes."""
padding = {
'in': 0.0,
'inout': 0.5,
'out': 1.0
}
return self._size * padding[self._tickdir]
def get_children(self):
children = [self.tick1line, self.tick2line,
self.gridline, self.label1, self.label2]
return children
def set_clip_path(self, path, transform=None):
# docstring inherited
super().set_clip_path(path, transform)
self.gridline.set_clip_path(path, transform)
self.stale = True
def contains(self, mouseevent):
"""
Test whether the mouse event occurred in the Tick marks.
This function always returns false. It is more useful to test if the
axis as a whole contains the mouse rather than the set of tick marks.
"""
return False, {}
def set_pad(self, val):
"""
Set the tick label pad in points
Parameters
----------
val : float
"""
self._apply_params(pad=val)
self.stale = True
def get_pad(self):
"""Get the value of the tick label pad in points."""
return self._base_pad
def get_loc(self):
"""Return the tick location (data coords) as a scalar."""
return self._loc
@martist.allow_rasterization
def draw(self, renderer):
if not self.get_visible():
self.stale = False
return
renderer.open_group(self.__name__, gid=self.get_gid())
for artist in [self.gridline, self.tick1line, self.tick2line,
self.label1, self.label2]:
artist.draw(renderer)
renderer.close_group(self.__name__)
self.stale = False
def set_url(self, url):
"""
Set the url of label1 and label2.
Parameters
----------
url : str
"""
super().set_url(url)
self.label1.set_url(url)
self.label2.set_url(url)
self.stale = True
def _set_artist_props(self, a):
a.set_figure(self.get_figure(root=False))
def get_view_interval(self):
"""
Return the view limits ``(min, max)`` of the axis the tick belongs to.
"""
raise NotImplementedError('Derived must override')
def _apply_params(self, **kwargs):
for name, target in [("gridOn", self.gridline),
("tick1On", self.tick1line),
("tick2On", self.tick2line),
("label1On", self.label1),
("label2On", self.label2)]:
if name in kwargs:
target.set_visible(kwargs.pop(name))
if any(k in kwargs for k in ['size', 'width', 'pad', 'tickdir']):
self._size = kwargs.pop('size', self._size)
# Width could be handled outside this block, but it is
# convenient to leave it here.
self._width = kwargs.pop('width', self._width)
self._base_pad = kwargs.pop('pad', self._base_pad)
# _apply_tickdir uses _size and _base_pad to make _pad, and also
# sets the ticklines markers.
self._apply_tickdir(kwargs.pop('tickdir', self._tickdir))
for line in (self.tick1line, self.tick2line):
line.set_markersize(self._size)
line.set_markeredgewidth(self._width)
# _get_text1_transform uses _pad from _apply_tickdir.
trans = self._get_text1_transform()[0]
self.label1.set_transform(trans)
trans = self._get_text2_transform()[0]
self.label2.set_transform(trans)
tick_kw = {k: v for k, v in kwargs.items() if k in ['color', 'zorder']}
if 'color' in kwargs:
tick_kw['markeredgecolor'] = kwargs['color']
self.tick1line.set(**tick_kw)
self.tick2line.set(**tick_kw)
for k, v in tick_kw.items():
setattr(self, '_' + k, v)
if 'labelrotation' in kwargs:
self._set_labelrotation(kwargs.pop('labelrotation'))
self.label1.set(rotation=self._labelrotation[1])
self.label2.set(rotation=self._labelrotation[1])
label_kw = {k[5:]: v for k, v in kwargs.items()
if k in ['labelsize', 'labelcolor', 'labelfontfamily',
'labelrotation_mode']}
self.label1.set(**label_kw)
self.label2.set(**label_kw)
grid_kw = {k[5:]: v for k, v in kwargs.items()
if k in _gridline_param_names}
# If grid_color has an alpha channel and grid_alpha is not explicitly
# set, extract the alpha from the color.
if 'color' in grid_kw and 'alpha' not in grid_kw:
grid_color = grid_kw['color']
if mcolors._has_alpha_channel(grid_color):
# Convert to rgba to extract alpha
rgba = mcolors.to_rgba(grid_color)
grid_kw['color'] = rgba[:3] # RGB only
grid_kw['alpha'] = rgba[3] # Alpha channel
self.gridline.set(**grid_kw)
def update_position(self, loc):
"""Set the location of tick in data coords with scalar *loc*."""
raise NotImplementedError('Derived must override')
def _get_text1_transform(self):
raise NotImplementedError('Derived must override')
def _get_text2_transform(self):
raise NotImplementedError('Derived must override')
class XTick(Tick):
"""
Contains all the Artists needed to make an x tick - the tick line,
the label text and the grid line
"""
__name__ = 'xtick'
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# x in data coords, y in axes coords
ax = self.axes
self.tick1line.set(
data=([0], [0]), transform=ax.get_xaxis_transform("tick1"))
self.tick2line.set(
data=([0], [1]), transform=ax.get_xaxis_transform("tick2"))
self.gridline.set(
data=([0, 0], [0, 1]), transform=ax.get_xaxis_transform("grid"))
# the y loc is 3 points below the min of y axis
trans, va, ha = self._get_text1_transform()
self.label1.set(
x=0, y=0,
verticalalignment=va, horizontalalignment=ha, transform=trans,
)
trans, va, ha = self._get_text2_transform()
self.label2.set(
x=0, y=1,
verticalalignment=va, horizontalalignment=ha, transform=trans,
)
def _get_text1_transform(self):
return self.axes.get_xaxis_text1_transform(self._pad)
def _get_text2_transform(self):
return self.axes.get_xaxis_text2_transform(self._pad)
def _apply_tickdir(self, tickdir):
# docstring inherited
super()._apply_tickdir(tickdir)
mark1, mark2 = {
'out': (mlines.TICKDOWN, mlines.TICKUP),
'in': (mlines.TICKUP, mlines.TICKDOWN),
'inout': ('|', '|'),
}[self._tickdir]
self.tick1line.set_marker(mark1)
self.tick2line.set_marker(mark2)
def update_position(self, loc):
"""Set the location of tick in data coords with scalar *loc*."""
self.tick1line.set_xdata((loc,))
self.tick2line.set_xdata((loc,))
self.gridline.set_xdata((loc,))
self.label1.set_x(loc)
self.label2.set_x(loc)
self._loc = loc
self.stale = True
def get_view_interval(self):
# docstring inherited
return self.axes.viewLim.intervalx
class YTick(Tick):
"""
Contains all the Artists needed to make a Y tick - the tick line,
the label text and the grid line
"""
__name__ = 'ytick'
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# x in axes coords, y in data coords
ax = self.axes
self.tick1line.set(
data=([0], [0]), transform=ax.get_yaxis_transform("tick1"))
self.tick2line.set(
data=([1], [0]), transform=ax.get_yaxis_transform("tick2"))
self.gridline.set(
data=([0, 1], [0, 0]), transform=ax.get_yaxis_transform("grid"))
# the y loc is 3 points below the min of y axis
trans, va, ha = self._get_text1_transform()
self.label1.set(
x=0, y=0,
verticalalignment=va, horizontalalignment=ha, transform=trans,
)
trans, va, ha = self._get_text2_transform()
self.label2.set(
x=1, y=0,
verticalalignment=va, horizontalalignment=ha, transform=trans,
)
def _get_text1_transform(self):
return self.axes.get_yaxis_text1_transform(self._pad)
def _get_text2_transform(self):
return self.axes.get_yaxis_text2_transform(self._pad)
def _apply_tickdir(self, tickdir):
# docstring inherited
super()._apply_tickdir(tickdir)
mark1, mark2 = {
'out': (mlines.TICKLEFT, mlines.TICKRIGHT),
'in': (mlines.TICKRIGHT, mlines.TICKLEFT),
'inout': ('_', '_'),
}[self._tickdir]
self.tick1line.set_marker(mark1)
self.tick2line.set_marker(mark2)
def update_position(self, loc):
"""Set the location of tick in data coords with scalar *loc*."""
self.tick1line.set_ydata((loc,))
self.tick2line.set_ydata((loc,))
self.gridline.set_ydata((loc,))
self.label1.set_y(loc)
self.label2.set_y(loc)
self._loc = loc
self.stale = True
def get_view_interval(self):
# docstring inherited
return self.axes.viewLim.intervaly
class Ticker:
"""
A container for the objects defining tick position and format.
Attributes
----------
locator : `~matplotlib.ticker.Locator` subclass
Determines the positions of the ticks.
formatter : `~matplotlib.ticker.Formatter` subclass
Determines the format of the tick labels.
"""
def __init__(self):
self._locator = None
self._formatter = None
self._locator_is_default = True
self._formatter_is_default = True
@property
def locator(self):
return self._locator
@locator.setter
def locator(self, locator):
if not isinstance(locator, mticker.Locator):
raise TypeError('locator must be a subclass of '
'matplotlib.ticker.Locator')
self._locator = locator
@property
def formatter(self):
return self._formatter
@formatter.setter
def formatter(self, formatter):
if not isinstance(formatter, mticker.Formatter):
raise TypeError('formatter must be a subclass of '
'matplotlib.ticker.Formatter')
self._formatter = formatter
class _LazyTickList:
"""
A descriptor for lazy instantiation of tick lists.
See comment above definition of the ``majorTicks`` and ``minorTicks``
attributes.
"""
def __init__(self, major):
self._major = major
def __get__(self, instance, owner):
if instance is None:
return self
else:
# instance._get_tick() can itself try to access the majorTicks
# attribute (e.g. in certain projection classes which override
# e.g. get_xaxis_text1_transform). In order to avoid infinite
# recursion, first set the majorTicks on the instance temporarily
# to an empty list. Then create the tick; note that _get_tick()
# may call reset_ticks(). Therefore, the final tick list is
# created and assigned afterwards.
if self._major:
instance.majorTicks = []
tick = instance._get_tick(major=True)
instance.majorTicks = [tick]
return instance.majorTicks
else:
instance.minorTicks = []
tick = instance._get_tick(major=False)
instance.minorTicks = [tick]
return instance.minorTicks
class Axis(martist.Artist):
"""
Base class for `.XAxis` and `.YAxis`.
Attributes
----------
isDefault_label : bool
axes : `~matplotlib.axes.Axes`
The `~.axes.Axes` to which the Axis belongs.
major : `~matplotlib.axis.Ticker`
Determines the major tick positions and their label format.
minor : `~matplotlib.axis.Ticker`
Determines the minor tick positions and their label format.
callbacks : `~matplotlib.cbook.CallbackRegistry`
label : `~matplotlib.text.Text`
The axis label.
labelpad : float
The distance between the axis label and the tick labels.
Defaults to :rc:`axes.labelpad`.
offsetText : `~matplotlib.text.Text`
A `.Text` object containing the data offset of the ticks (if any).
pickradius : float
The acceptance radius for containment tests. See also `.Axis.contains`.
majorTicks : list of `.Tick`
The major ticks.
.. warning::
Ticks are not guaranteed to be persistent. Various operations
can create, delete and modify the Tick instances. There is an
imminent risk that changes to individual ticks will not
survive if you work on the figure further (including also
panning/zooming on a displayed figure).
Working on the individual ticks is a method of last resort.
Use `.set_tick_params` instead if possible.
minorTicks : list of `.Tick`
The minor ticks.
"""
OFFSETTEXTPAD = 3
# The class used in _get_tick() to create tick instances. Must either be
# overwritten in subclasses, or subclasses must reimplement _get_tick().
_tick_class = None
converter = _api.deprecate_privatize_attribute(
"3.10",
alternative="get_converter and set_converter methods"
)
def __str__(self):
return "{}({},{})".format(
type(self).__name__, *self.axes.transAxes.transform((0, 0)))
def __init__(self, axes, *, pickradius=15, clear=True):
"""
Parameters
----------
axes : `~matplotlib.axes.Axes`
The `~.axes.Axes` to which the created Axis belongs.
pickradius : float
The acceptance radius for containment tests. See also
`.Axis.contains`.
clear : bool, default: True
Whether to clear the Axis on creation. This is not required, e.g., when
creating an Axis as part of an Axes, as ``Axes.clear`` will call
``Axis.clear``.
.. versionadded:: 3.8
"""
super().__init__()
self._remove_overlapping_locs = True
self.set_figure(axes.get_figure(root=False))
self.isDefault_label = True
self.axes = axes
self.major = Ticker()
self.minor = Ticker()
self.callbacks = cbook.CallbackRegistry(signals=["units"])
self._autolabelpos = True
self.label = mtext.Text(
np.nan, np.nan,
fontsize=mpl.rcParams['axes.labelsize'],
fontweight=mpl.rcParams['axes.labelweight'],
color=mpl.rcParams['axes.labelcolor'],
) #: The `.Text` object of the axis label.
self._set_artist_props(self.label)
self.offsetText = mtext.Text(np.nan, np.nan)
self._set_artist_props(self.offsetText)
self.labelpad = mpl.rcParams['axes.labelpad']
self.pickradius = pickradius
# Initialize here for testing; later add API
self._major_tick_kw = dict()
self._minor_tick_kw = dict()
if clear:
self.clear()
else:
self._converter = None
self._converter_is_explicit = False
self.units = None
self._autoscale_on = True
@property
def isDefault_majloc(self):
return self.major._locator_is_default
@isDefault_majloc.setter
def isDefault_majloc(self, value):
self.major._locator_is_default = value
@property
def isDefault_majfmt(self):
return self.major._formatter_is_default
@isDefault_majfmt.setter
def isDefault_majfmt(self, value):
self.major._formatter_is_default = value
@property
def isDefault_minloc(self):
return self.minor._locator_is_default
@isDefault_minloc.setter
def isDefault_minloc(self, value):
self.minor._locator_is_default = value
@property
def isDefault_minfmt(self):
return self.minor._formatter_is_default
@isDefault_minfmt.setter
def isDefault_minfmt(self, value):
self.minor._formatter_is_default = value
def _get_shared_axes(self):
"""Return a list of shared Axes for current axis."""
return self.axes._shared_axes[
self._get_axis_name()].get_siblings(self.axes)
def _get_shared_axis(self):
"""Return list of shared axis for current axis."""
name = self._get_axis_name()
return [ax._axis_map[name] for ax in self._get_shared_axes()]
def _get_axis_name(self):
"""Return the axis name."""
return next(name for name, axis in self.axes._axis_map.items()
if axis is self)
# During initialization, Axis objects often create ticks that are later
# unused; this turns out to be a very slow step. Instead, use a custom
# descriptor to make the tick lists lazy and instantiate them as needed.
majorTicks = _LazyTickList(major=True)
minorTicks = _LazyTickList(major=False)
def get_remove_overlapping_locs(self):
return self._remove_overlapping_locs
def set_remove_overlapping_locs(self, val):
self._remove_overlapping_locs = bool(val)
remove_overlapping_locs = property(
get_remove_overlapping_locs, set_remove_overlapping_locs,
doc=('If minor ticker locations that overlap with major '
'ticker locations should be trimmed.'))
def set_label_coords(self, x, y, transform=None):
"""
Set the coordinates of the label.
By default, the x coordinate of the y label and the y coordinate of the
x label are determined by the tick label bounding boxes, but this can
lead to poor alignment of multiple labels if there are multiple Axes.
You can also specify the coordinate system of the label with the
transform. If None, the default coordinate system will be the axes
coordinate system: (0, 0) is bottom left, (0.5, 0.5) is center, etc.
"""
self._autolabelpos = False
if transform is None:
transform = self.axes.transAxes
self.label.set_transform(transform)
self.label.set_position((x, y))
self.stale = True
def get_transform(self):
"""Return the transform used in the Axis' scale"""
return self._scale.get_transform()
def get_scale(self):
"""Return this Axis' scale (as a str)."""
return self._scale.name
def _set_scale(self, value, **kwargs):
if not isinstance(value, mscale.ScaleBase):
self._scale = mscale.scale_factory(value, self, **kwargs)
else:
self._scale = value
self._scale.set_default_locators_and_formatters(self)
self.isDefault_majloc = True
self.isDefault_minloc = True
self.isDefault_majfmt = True
self.isDefault_minfmt = True
# This method is directly wrapped by Axes.set_{x,y}scale.
def _set_axes_scale(self, value, **kwargs):
"""
Set this Axis' scale.
Parameters
----------
value : str or `.ScaleBase`
The axis scale type to apply. Valid string values are the names of scale
classes ("linear", "log", "function",...). These may be the names of any
of the :ref:`built-in scales<builtin_scales>` or of any custom scales
registered using `matplotlib.scale.register_scale`.
**kwargs
If *value* is a string, keywords are passed to the instantiation method of
the respective class.
"""
name = self._get_axis_name()
old_default_lims = (self.get_major_locator()
.nonsingular(-np.inf, np.inf))
for ax in self._get_shared_axes():
ax._axis_map[name]._set_scale(value, **kwargs)
ax._update_transScale()
ax.stale = True
new_default_lims = (self.get_major_locator()
.nonsingular(-np.inf, np.inf))
if old_default_lims != new_default_lims:
# Force autoscaling now, to take advantage of the scale locator's
# nonsingular() before it possibly gets swapped out by the user.
self.axes.autoscale_view(
**{f"scale{k}": k == name for k in self.axes._axis_names})
def limit_range_for_scale(self, vmin, vmax):
"""
Return the range *vmin*, *vmax*, restricted to the domain supported by the
current scale.
"""
return self._scale.limit_range_for_scale(vmin, vmax, self.get_minpos())
def _nan_out_of_scale_range(self, data):
"""
Return *data* with values that are out of range for this axis's scale
replaced by NaN. E.g. ``<=0`` on a log axis.
"""
data = np.asanyarray(data, dtype=float)
valid = self._scale.val_in_range(data)
return data if np.all(valid) else np.where(valid, data, np.nan)
def _get_autoscale_on(self):
"""Return whether this Axis is autoscaled."""
return self._autoscale_on
def _set_autoscale_on(self, b):
"""
Set whether this Axis is autoscaled when drawing or by `.Axes.autoscale_view`.
If b is None, then the value is not changed.
Parameters
----------
b : bool
See Also
--------
matplotlib.axes.Axes.autoscale
matplotlib.axes.Axes.set_autoscale_on
matplotlib.axes.Axes.get_autoscalex_on
matplotlib.axes.Axes.set_autoscalex_on
matplotlib.axes.Axes.get_autoscaley_on
matplotlib.axes.Axes.set_autoscaley_on
"""
if b is not None:
self._autoscale_on = b
def get_children(self):
return [self.label, self.offsetText,
*self.get_major_ticks(), *self.get_minor_ticks()]
def _reset_major_tick_kw(self):
self._major_tick_kw.clear()
self._major_tick_kw['gridOn'] = (
mpl.rcParams['axes.grid'] and
mpl.rcParams['axes.grid.which'] in ('both', 'major'))
def _reset_minor_tick_kw(self):
self._minor_tick_kw.clear()
self._minor_tick_kw['gridOn'] = (
mpl.rcParams['axes.grid'] and
mpl.rcParams['axes.grid.which'] in ('both', 'minor'))
def clear(self):
"""
Clear the axis.
This resets axis properties to their default values:
- the label
- the scale
- locators, formatters and ticks
- major and minor grid
- units
- registered callbacks
"""
self.label._reset_visual_defaults()
# The above resets the label formatting using text rcParams,
# so we then update the formatting using axes rcParams
self.label.set_color(mpl.rcParams['axes.labelcolor'])
self.label.set_fontsize(mpl.rcParams['axes.labelsize'])
self.label.set_fontweight(mpl.rcParams['axes.labelweight'])
self.offsetText._reset_visual_defaults()
self.labelpad = mpl.rcParams['axes.labelpad']
self._init()
self._set_scale('linear')
# Clear the callback registry for this axis, or it may "leak"
self.callbacks = cbook.CallbackRegistry(signals=["units"])
# whether the grids are on
self._major_tick_kw['gridOn'] = (
mpl.rcParams['axes.grid'] and
mpl.rcParams['axes.grid.which'] in ('both', 'major'))
self._minor_tick_kw['gridOn'] = (
mpl.rcParams['axes.grid'] and
mpl.rcParams['axes.grid.which'] in ('both', 'minor'))
self.reset_ticks()
self._converter = None
self._converter_is_explicit = False
self.units = None
self.stale = True
def reset_ticks(self):
"""
Re-initialize the major and minor Tick lists.
Each list starts with a single fresh Tick.
"""
# Restore the lazy tick lists.
try:
del self.majorTicks
except AttributeError:
pass
try:
del self.minorTicks
except AttributeError:
pass
try:
self.set_clip_path(self.axes.patch)
except AttributeError:
pass
def minorticks_on(self):
"""
Display default minor ticks on the Axis, depending on the scale
(`~.axis.Axis.get_scale`).
Scales use specific minor locators:
- log: `~.LogLocator`
- symlog: `~.SymmetricalLogLocator`
- asinh: `~.AsinhLocator`
- logit: `~.LogitLocator`
- default: `~.AutoMinorLocator`
Displaying minor ticks may reduce performance; you may turn them off
using `minorticks_off()` if drawing speed is a problem.
"""
scale = self.get_scale()
if scale == 'log':
s = self._scale
self.set_minor_locator(mticker.LogLocator(s.base, s.subs))
elif scale == 'symlog':
s = self._scale
self.set_minor_locator(
mticker.SymmetricalLogLocator(s._transform, s.subs))
elif scale == 'asinh':
s = self._scale
self.set_minor_locator(
mticker.AsinhLocator(s.linear_width, base=s._base,
subs=s._subs))
elif scale == 'logit':
self.set_minor_locator(mticker.LogitLocator(minor=True))
else:
self.set_minor_locator(mticker.AutoMinorLocator())
def minorticks_off(self):
"""Remove minor ticks from the Axis."""
self.set_minor_locator(mticker.NullLocator())
def set_tick_params(self, which='major', reset=False, **kwargs):
"""
Set appearance parameters for ticks, ticklabels, and gridlines.
For documentation of keyword arguments, see
:meth:`matplotlib.axes.Axes.tick_params`.
See Also
--------
You can’t perform that action at this time.