1******************* 2``matplotlib.axis`` 3******************* 4 5.. contents:: Table of Contents 6 :depth: 3 7 :local: 8 :backlinks: entry 9 10.. automodule:: matplotlib.axis 11 :no-members: 12 :no-undoc-members: 13 14Inheritance 15=========== 16 17.. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick 18 :private-bases: 19 20 21``Axis`` objects 22================ 23 24.. autoclass:: Axis 25 :no-members: 26 :no-undoc-members: 27.. autoclass:: XAxis 28 :no-members: 29 :no-undoc-members: 30.. autoclass:: YAxis 31 :no-members: 32 :no-undoc-members: 33.. autoclass:: Ticker 34 :no-members: 35 :no-undoc-members: 36 37 38.. autosummary:: 39 :toctree: _as_gen 40 :template: autosummary.rst 41 :nosignatures: 42 43 Axis.clear 44 Axis.cla 45 Axis.get_scale 46 47 48Formatters and Locators 49----------------------- 50 51.. autosummary:: 52 :toctree: _as_gen 53 :template: autosummary.rst 54 :nosignatures: 55 56 Axis.get_major_formatter 57 Axis.get_major_locator 58 Axis.get_minor_formatter 59 Axis.get_minor_locator 60 Axis.set_major_formatter 61 Axis.set_major_locator 62 Axis.set_minor_formatter 63 Axis.set_minor_locator 64 65 Axis.remove_overlapping_locs 66 Axis.get_remove_overlapping_locs 67 Axis.set_remove_overlapping_locs 68 69Axis Label 70---------- 71 72.. autosummary:: 73 :toctree: _as_gen 74 :template: autosummary.rst 75 :nosignatures: 76 77 Axis.set_label_coords 78 Axis.set_label_position 79 Axis.set_label_text 80 Axis.get_label 81 Axis.get_label_position 82 Axis.get_label_text 83 84Ticks, tick labels and Offset text 85---------------------------------- 86 87.. autosummary:: 88 :toctree: _as_gen 89 :template: autosummary.rst 90 :nosignatures: 91 92 Axis.get_major_ticks 93 Axis.get_majorticklabels 94 Axis.get_majorticklines 95 Axis.get_majorticklocs 96 Axis.get_minor_ticks 97 Axis.get_minorticklabels 98 Axis.get_minorticklines 99 Axis.get_minorticklocs 100 101 Axis.get_offset_text 102 103 Axis.get_tick_padding 104 Axis.get_ticklabels 105 Axis.get_ticklines 106 Axis.get_ticklocs 107 108 Axis.get_gridlines 109 Axis.grid 110 111 Axis.set_tick_params 112 113 Axis.axis_date 114 115 116Data and view intervals 117----------------------- 118 119.. autosummary:: 120 :toctree: _as_gen 121 :template: autosummary.rst 122 :nosignatures: 123 124 Axis.get_data_interval 125 Axis.get_view_interval 126 Axis.get_inverted 127 Axis.set_data_interval 128 Axis.set_view_interval 129 Axis.set_inverted 130 131Rendering helpers 132----------------- 133 134.. autosummary:: 135 :toctree: _as_gen 136 :template: autosummary.rst 137 :nosignatures: 138 139 Axis.get_minpos 140 Axis.get_tick_space 141 Axis.get_ticklabel_extents 142 Axis.get_tightbbox 143 144 145Interactive 146----------- 147 148.. autosummary:: 149 :toctree: _as_gen 150 :template: autosummary.rst 151 :nosignatures: 152 153 Axis.contains 154 Axis.get_pickradius 155 Axis.set_pickradius 156 157 158Units 159----- 160 161.. autosummary:: 162 :toctree: _as_gen 163 :template: autosummary.rst 164 :nosignatures: 165 166 Axis.convert_units 167 Axis.set_units 168 Axis.get_units 169 Axis.update_units 170 171 172Incremental navigation 173---------------------- 174 175.. autosummary:: 176 :toctree: _as_gen 177 :template: autosummary.rst 178 :nosignatures: 179 180 Axis.pan 181 Axis.zoom 182 183XAxis Specific 184-------------- 185 186.. autosummary:: 187 :toctree: _as_gen 188 :template: autosummary.rst 189 :nosignatures: 190 191 XAxis.axis_name 192 XAxis.get_text_heights 193 XAxis.get_ticks_position 194 XAxis.set_ticks_position 195 XAxis.tick_bottom 196 XAxis.tick_top 197 198YAxis Specific 199-------------- 200 201.. autosummary:: 202 :toctree: _as_gen 203 :template: autosummary.rst 204 :nosignatures: 205 206 YAxis.axis_name 207 YAxis.get_text_widths 208 YAxis.get_ticks_position 209 YAxis.set_offset_position 210 YAxis.set_ticks_position 211 YAxis.tick_left 212 YAxis.tick_right 213 214Other 215----- 216 217.. autosummary:: 218 :toctree: _as_gen 219 :template: autosummary.rst 220 :nosignatures: 221 222 223 Axis.OFFSETTEXTPAD 224 225 Axis.axes 226 Axis.limit_range_for_scale 227 Axis.reset_ticks 228 Axis.set_default_intervals 229 230Discouraged 231----------- 232 233These methods should be used together with care, calling ``set_ticks`` 234to specify the desired tick locations **before** calling ``set_ticklabels`` to 235specify a matching series of labels. Calling ``set_ticks`` makes a 236`~matplotlib.ticker.FixedLocator`; it's list of locations is then used by 237``set_ticklabels`` to make an appropriate 238`~matplotlib.ticker.FuncFormatter`. 239 240.. autosummary:: 241 :toctree: _as_gen 242 :template: autosummary.rst 243 :nosignatures: 244 245 Axis.set_ticks 246 Axis.set_ticklabels 247 248 249 250``Tick`` objects 251================ 252 253.. autoclass:: Tick 254 :no-members: 255 :no-undoc-members: 256.. autoclass:: XTick 257 :no-members: 258 :no-undoc-members: 259.. autoclass:: YTick 260 :no-members: 261 :no-undoc-members: 262 263 264.. autosummary:: 265 :toctree: _as_gen 266 :template: autosummary.rst 267 :nosignatures: 268 269 270 Tick.apply_tickdir 271 Tick.get_loc 272 Tick.get_pad 273 Tick.get_pad_pixels 274 Tick.get_tick_padding 275 Tick.get_tickdir 276 Tick.get_view_interval 277 Tick.set_label1 278 Tick.set_label2 279 Tick.set_pad 280 Tick.update_position 281