Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3275070

Browse files
committed
add axis and cbook to api reference
svn path=/trunk/matplotlib/; revision=5550
1 parent 2e75ae3 commit 3275070

3 files changed

Lines changed: 126 additions & 93 deletions

File tree

doc/api/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,7 @@
1414
matplotlib_configuration_api.rst
1515
artist_api.rst
1616
axes_api.rst
17+
axis_api.rst
18+
cbook_api.rst
1719
pyplot_api.rst
1820
index_backend_api.rst

lib/matplotlib/axis.py

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,37 @@ class Tick(artist.Artist):
2323
1 refers to the bottom of the plot for xticks and the left for yticks
2424
2 refers to the top of the plot for xticks and the right for yticks
2525
26-
Publicly accessible attributes
27-
28-
tick1line : a Line2D instance
29-
tick2line : a Line2D instance
30-
gridline : a Line2D instance
31-
label1 : a Text instance
32-
label2 : a Text instance
33-
gridOn : a boolean which determines whether to draw the tickline
34-
tick1On : a boolean which determines whether to draw the 1st tickline
35-
tick2On : a boolean which determines whether to draw the 2nd tickline
36-
label1On : a boolean which determines whether to draw tick label
37-
label2On : a boolean which determines whether to draw tick label
26+
Publicly accessible attributes:
27+
28+
:attr:`tick1line`
29+
a Line2D instance
30+
31+
:attr:`tick2line`
32+
a Line2D instance
33+
34+
:attr:`gridline`
35+
a Line2D instance
36+
37+
:attr:`label1`
38+
a Text instance
39+
40+
:attr:`label2`
41+
a Text instance
42+
43+
:attr:`gridOn`
44+
a boolean which determines whether to draw the tickline
45+
46+
:attr:`tick1On`
47+
a boolean which determines whether to draw the 1st tickline
48+
49+
:attr:`tick2On`
50+
a boolean which determines whether to draw the 2nd tickline
51+
52+
:attr:`label1On`
53+
a boolean which determines whether to draw tick label
54+
55+
:attr:`label2On`
56+
a boolean which determines whether to draw tick label
3857
3958
"""
4059
def __init__(self, axes, loc, label,
@@ -111,7 +130,8 @@ def get_pad_pixels(self):
111130
return self.figure.dpi * self._pad / 72.0
112131

113132
def contains(self, mouseevent):
114-
"""Test whether the mouse event occured in the Tick marks.
133+
"""
134+
Test whether the mouse event occured in the Tick marks.
115135
116136
This function always returns false. It is more useful to test if the
117137
axis as a whole contains the mouse rather than the set of tick marks.

0 commit comments

Comments
 (0)