You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
<divid="unreleased-message"> You are reading an old version of the documentation (v1.4.0). For the latest version see <ahref="https://matplotlib.org/stable/api/axis_api.html">https://matplotlib.org/stable/api/axis_api.html</a></div>
<h1>axis<aclass="headerlink" href="#axis" title="Permalink to this headline">¶</a></h1>
<divclass="section" id="module-matplotlib.axis">
<spanid="matplotlib-axis"></span><h2><aclass="reference internal" href="#module-matplotlib.axis" title="matplotlib.axis"><ttclass="xref py py-mod docutils literal"><spanclass="pre">matplotlib.axis</span></tt></a><aclass="headerlink" href="#module-matplotlib.axis" title="Permalink to this headline">¶</a></h2>
<p>Classes for the ticks and x and y axis</p>
<dlclass="class">
<dtid="matplotlib.axis.Axis">
<emclass="property">class </em><ttclass="descclassname">matplotlib.axis.</tt><ttclass="descname">Axis</tt><spanclass="sig-paren">(</span><em>axes</em>, <em>pickradius=15</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis" title="Permalink to this definition">¶</a></dt>
<li><ttclass="xref py py-attr docutils literal"><spanclass="pre">labelpad</span></tt> - number of points between the axis and its label</li>
</ul>
<p>Init the axis with the parent Axes instance</p>
<dlclass="attribute">
<dtid="matplotlib.axis.Axis.OFFSETTEXTPAD">
<ttclass="descname">OFFSETTEXTPAD</tt><emclass="property"> = 3</em><aclass="headerlink" href="#matplotlib.axis.Axis.OFFSETTEXTPAD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.axis_date">
<ttclass="descname">axis_date</tt><spanclass="sig-paren">(</span><em>tz=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.axis_date" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets up x-axis ticks and labels that treat the x data as dates.
<em>tz</em> is a <ttclass="xref py py-class docutils literal"><spanclass="pre">tzinfo</span></tt> instance or a timezone string.
This timezone is used to create date labels.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.cla">
<ttclass="descname">cla</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.cla" title="Permalink to this definition">¶</a></dt>
<dd><p>clear the current axis</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.convert_units">
<ttclass="descname">convert_units</tt><spanclass="sig-paren">(</span><em>x</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.convert_units" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.draw">
<ttclass="descname">draw</tt><spanclass="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the axis lines, grid lines, tick lines and labels</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_children">
<ttclass="descname">get_children</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_data_interval">
<ttclass="descname">get_data_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis data limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_gridlines">
<ttclass="descname">get_gridlines</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_gridlines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the grid lines as a list of Line2D instance</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_label">
<ttclass="descname">get_label</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the axis label as a Text instance</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_label_text">
<ttclass="descname">get_label_text</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_label_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the text of the label</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_major_formatter">
<ttclass="descname">get_major_formatter</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_major_formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the formatter of the major ticker</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_major_locator">
<ttclass="descname">get_major_locator</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_major_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the locator of the major ticker</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_major_ticks">
<ttclass="descname">get_major_ticks</tt><spanclass="sig-paren">(</span><em>numticks=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_major_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>get the tick instances; grow as necessary</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_majorticklabels">
<ttclass="descname">get_majorticklabels</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_majorticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of Text instances for the major ticklabels</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_majorticklines">
<ttclass="descname">get_majorticklines</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_majorticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the major tick lines as a list of Line2D instances</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_majorticklocs">
<ttclass="descname">get_majorticklocs</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_majorticklocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the major tick locations in data coordinates as a numpy array</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_minor_formatter">
<ttclass="descname">get_minor_formatter</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_minor_formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the formatter of the minor ticker</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_minor_locator">
<ttclass="descname">get_minor_locator</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_minor_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the locator of the minor ticker</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_minor_ticks">
<ttclass="descname">get_minor_ticks</tt><spanclass="sig-paren">(</span><em>numticks=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_minor_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>get the minor tick instances; grow as necessary</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_minorticklabels">
<ttclass="descname">get_minorticklabels</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_minorticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of Text instances for the minor ticklabels</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_minorticklines">
<ttclass="descname">get_minorticklines</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_minorticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the minor tick lines as a list of Line2D instances</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_minorticklocs">
<ttclass="descname">get_minorticklocs</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_minorticklocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the minor tick locations in data coordinates as a numpy array</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_offset_text">
<ttclass="descname">get_offset_text</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_offset_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the axis offsetText as a Text instance</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_pickradius">
<ttclass="descname">get_pickradius</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_pickradius" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the depth of the axis used by the picker</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_scale">
<ttclass="descname">get_scale</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_scale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_smart_bounds">
<ttclass="descname">get_smart_bounds</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_smart_bounds" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">get_ticklabel_extents</tt><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_ticklabel_extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the extents of the tick labels on either side
of the axes.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_ticklabels">
<ttclass="descname">get_ticklabels</tt><spanclass="sig-paren">(</span><em>minor=False</em>, <em>which=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_ticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the x tick labels as a list of <aclass="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><ttclass="xref py py-class docutils literal"><spanclass="pre">Text</span></tt></a>
<ttclass="descname">get_ticklines</tt><spanclass="sig-paren">(</span><em>minor=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_ticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tick lines as a list of Line2D instances</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_ticklocs">
<ttclass="descname">get_ticklocs</tt><spanclass="sig-paren">(</span><em>minor=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_ticklocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the tick locations in data coordinates as a numpy array</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_tightbbox">
<ttclass="descname">get_tightbbox</tt><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_tightbbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a bounding box that encloses the axis. It only accounts
tick labels, axis label, and offsetText.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_transform">
<ttclass="descname">get_transform</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_transform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_units">
<ttclass="descname">get_units</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_units" title="Permalink to this definition">¶</a></dt>
<dd><p>return the units for axis</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.get_view_interval">
<ttclass="descname">get_view_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.grid">
<ttclass="descname">grid</tt><spanclass="sig-paren">(</span><em>b=None</em>, <em>which=u'major'</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the axis grid on or off; b is a boolean. Use <em>which</em> =
‘major’ | ‘minor’ | ‘both’ to set the grid for major or minor ticks.</p>
<p>If <em>b</em> is <em>None</em> and len(kwargs)==0, toggle the grid state. If
<em>kwargs</em> are supplied, it is assumed you want the grid on and <em>b</em>
will be set to True.</p>
<p><em>kwargs</em> are used to set the line properties of the grids, eg,</p>
<ttclass="descname">have_units</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.have_units" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.iter_ticks">
<ttclass="descname">iter_ticks</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.iter_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Iterate through all of the major and minor ticks.</p>
<ttclass="descname">limit_range_for_scale</tt><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.pan">
<ttclass="descname">pan</tt><spanclass="sig-paren">(</span><em>numsteps</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Pan <em>numsteps</em> (can be positive or negative)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.reset_ticks">
<ttclass="descname">reset_ticks</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.reset_ticks" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_clip_path">
<ttclass="descname">set_clip_path</tt><spanclass="sig-paren">(</span><em>clippath</em>, <em>transform=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_data_interval">
<ttclass="descname">set_data_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_data_interval" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_default_intervals</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_default_intervals" title="Permalink to this definition">¶</a></dt>
<dd><p>set the default limits for the axis data and view interval if they
are not mutated</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_label_coords">
<ttclass="descname">set_label_coords</tt><spanclass="sig-paren">(</span><em>x</em>, <em>y</em>, <em>transform=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_label_coords" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the coordinates of the label. By default, the x
coordinate of the y label is determined by the tick label
bounding boxes, but this can lead to poor alignment of
multiple ylabels if there are multiple axes. Ditto for the y
coodinate of the x label.</p>
<p>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 (left,bottom), (0.5, 0.5)
is middle, etc</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_label_text">
<ttclass="descname">set_label_text</tt><spanclass="sig-paren">(</span><em>label</em>, <em>fontdict=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_label_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the text value of the axis label</p>
<p>ACCEPTS: A string value for the label</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_major_formatter">
<ttclass="descname">set_major_formatter</tt><spanclass="sig-paren">(</span><em>formatter</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_major_formatter" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_major_locator</tt><spanclass="sig-paren">(</span><em>locator</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_major_locator" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_minor_formatter</tt><spanclass="sig-paren">(</span><em>formatter</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_minor_formatter" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_minor_locator</tt><spanclass="sig-paren">(</span><em>locator</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_minor_locator" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_pickradius</tt><spanclass="sig-paren">(</span><em>pickradius</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_pickradius" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the depth of the axis used by the picker</p>
<p>ACCEPTS: a distance in points</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_scale">
<ttclass="descname">set_scale</tt><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_scale" title="Permalink to this definition">¶</a></dt>
<dd><divclass="deprecated">
<p><spanclass="versionmodified">Deprecated since version 1.3: </span>The set_scale function was deprecated in version 1.3.</p>
</div>
<p>This should be a private function (moved to _set_scale)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_smart_bounds">
<ttclass="descname">set_smart_bounds</tt><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_smart_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>set the axis to have smart bounds</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_tick_params">
<ttclass="descname">set_tick_params</tt><spanclass="sig-paren">(</span><em>which=u'major'</em>, <em>reset=False</em>, <em>**kw</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_tick_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set appearance parameters for ticks and ticklabels.</p>
<ttclass="descname">set_ticklabels</tt><spanclass="sig-paren">(</span><em>ticklabels</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_ticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text values of the tick labels. Return a list of Text
instances. Use <em>kwarg</em><em>minor=True</em> to select minor ticks.
All other kwargs are used to update the text object properties.
As for get_ticklabels, label1 (left or bottom) is
affected for a given tick only if its label1On attribute
is True, and similarly for label2. The list of returned
label text objects consists of all such label1 objects followed
by all such label2 objects.</p>
<p>The input <em>ticklabels</em> is assumed to match the set of
tick locations, regardless of the state of label1On and
label2On.</p>
<p>ACCEPTS: sequence of strings</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_ticks">
<ttclass="descname">set_ticks</tt><spanclass="sig-paren">(</span><em>ticks</em>, <em>minor=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locations of the tick marks from sequence ticks</p>
<p>ACCEPTS: sequence of floats</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_units">
<ttclass="descname">set_units</tt><spanclass="sig-paren">(</span><em>u</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_units" title="Permalink to this definition">¶</a></dt>
<dd><p>set the units for axis</p>
<p>ACCEPTS: a units tag</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.set_view_interval">
<ttclass="descname">set_view_interval</tt><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.update_units">
<ttclass="descname">update_units</tt><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.update_units" title="Permalink to this definition">¶</a></dt>
<dd><p>introspect <em>data</em> for units converter and update the
axis.converter instance if necessary. Return <em>True</em>
if <em>data</em> is registered for unit conversion.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Axis.zoom">
<ttclass="descname">zoom</tt><spanclass="sig-paren">(</span><em>direction</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Axis.zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Zoom in/out on axis; if <em>direction</em> is >0 zoom in, else zoom out</p>
<dd>a boolean which determines whether to draw tick label</dd>
</dl>
</div></blockquote>
<p>bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in points</p>
<dlclass="method">
<dtid="matplotlib.axis.Tick.apply_tickdir">
<ttclass="descname">apply_tickdir</tt><spanclass="sig-paren">(</span><em>tickdir</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.apply_tickdir" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate self._pad and self._tickmarkers</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.contains">
<ttclass="descname">contains</tt><spanclass="sig-paren">(</span><em>mouseevent</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred in the Tick marks.</p>
<p>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.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.draw">
<ttclass="descname">draw</tt><spanclass="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.get_children">
<ttclass="descname">get_children</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.get_loc">
<ttclass="descname">get_loc</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.get_loc" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tick location (data coords) as a scalar</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.get_pad">
<ttclass="descname">get_pad</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.get_pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the value of the tick label pad in points</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.get_pad_pixels">
<ttclass="descname">get_pad_pixels</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.get_pad_pixels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.get_view_interval">
<ttclass="descname">get_view_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the view Interval instance for the axis this tick is ticking</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.set_clip_path">
<ttclass="descname">set_clip_path</tt><spanclass="sig-paren">(</span><em>clippath</em>, <em>transform=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip path, which may be:</p>
<ttclass="descname">set_label</tt><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.set_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text of ticklabel</p>
<p>ACCEPTS: str</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.set_label1">
<ttclass="descname">set_label1</tt><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.set_label1" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text of ticklabel</p>
<p>ACCEPTS: str</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.set_label2">
<ttclass="descname">set_label2</tt><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.set_label2" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text of ticklabel2</p>
<p>ACCEPTS: str</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.Tick.set_pad">
<ttclass="descname">set_pad</tt><spanclass="sig-paren">(</span><em>val</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.Tick.set_pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the tick label pad in points</p>
<p>ACCEPTS: float</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.axis.Ticker">
<emclass="property">class </em><ttclass="descclassname">matplotlib.axis.</tt><ttclass="descname">Ticker</tt><aclass="headerlink" href="#matplotlib.axis.Ticker" title="Permalink to this definition">¶</a></dt>
<dd><dlclass="attribute">
<dtid="matplotlib.axis.Ticker.formatter">
<ttclass="descname">formatter</tt><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.axis.Ticker.formatter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.axis.Ticker.locator">
<ttclass="descname">locator</tt><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.axis.Ticker.locator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.axis.XAxis">
<emclass="property">class </em><ttclass="descclassname">matplotlib.axis.</tt><ttclass="descname">XAxis</tt><spanclass="sig-paren">(</span><em>axes</em>, <em>pickradius=15</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis" title="Permalink to this definition">¶</a></dt>
<p>Init the axis with the parent Axes instance</p>
<dlclass="attribute">
<dtid="matplotlib.axis.XAxis.axis_name">
<ttclass="descname">axis_name</tt><emclass="property"> = u'x'</em><aclass="headerlink" href="#matplotlib.axis.XAxis.axis_name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.contains">
<ttclass="descname">contains</tt><spanclass="sig-paren">(</span><em>mouseevent</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occured in the x axis.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.get_data_interval">
<ttclass="descname">get_data_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.get_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis data limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.get_label_position">
<ttclass="descname">get_label_position</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.get_label_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the label position (top or bottom)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.get_minpos">
<ttclass="descname">get_minpos</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.get_minpos" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.get_text_heights">
<ttclass="descname">get_text_heights</tt><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.get_text_heights" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the amount of space one should reserve for text
above and below the axes. Returns a tuple (above, below)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.get_ticks_position">
<ttclass="descname">get_ticks_position</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.get_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the ticks position (top, bottom, default or unknown)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.get_view_interval">
<ttclass="descname">get_view_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.set_data_interval">
<ttclass="descname">set_data_interval</tt><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.set_data_interval" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_default_intervals</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.set_default_intervals" title="Permalink to this definition">¶</a></dt>
<dd><p>set the default limits for the axis interval if they are not mutated</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.set_label_position">
<ttclass="descname">set_label_position</tt><spanclass="sig-paren">(</span><em>position</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.set_label_position" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_ticks_position</tt><spanclass="sig-paren">(</span><em>position</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.set_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the ticks position (top, bottom, both, default or none)
both sets the ticks to appear on both positions, but does not
change the tick labels. ‘default’ resets the tick positions to
the default: ticks on both positions, labels at bottom. ‘none’
can be used if you don’t want any ticks. ‘none’ and ‘both’
<ttclass="descname">set_view_interval</tt><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>ignore</em> is <em>False</em>, the order of vmin, vmax
does not matter; the original axis orientation will
<ttclass="descname">tick_bottom</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.tick_bottom" title="Permalink to this definition">¶</a></dt>
<dd><p>use ticks only on bottom</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XAxis.tick_top">
<ttclass="descname">tick_top</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XAxis.tick_top" title="Permalink to this definition">¶</a></dt>
<p>Contains all the Artists needed to make an x tick - the tick line,
the label text and the grid line</p>
<p>bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in points</p>
<dlclass="method">
<dtid="matplotlib.axis.XTick.apply_tickdir">
<ttclass="descname">apply_tickdir</tt><spanclass="sig-paren">(</span><em>tickdir</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XTick.apply_tickdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XTick.get_view_interval">
<ttclass="descname">get_view_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XTick.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.XTick.update_position">
<ttclass="descname">update_position</tt><spanclass="sig-paren">(</span><em>loc</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.XTick.update_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the location of tick in data coords with scalar <em>loc</em></p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.axis.YAxis">
<emclass="property">class </em><ttclass="descclassname">matplotlib.axis.</tt><ttclass="descname">YAxis</tt><spanclass="sig-paren">(</span><em>axes</em>, <em>pickradius=15</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis" title="Permalink to this definition">¶</a></dt>
<p>Init the axis with the parent Axes instance</p>
<dlclass="attribute">
<dtid="matplotlib.axis.YAxis.axis_name">
<ttclass="descname">axis_name</tt><emclass="property"> = u'y'</em><aclass="headerlink" href="#matplotlib.axis.YAxis.axis_name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.contains">
<ttclass="descname">contains</tt><spanclass="sig-paren">(</span><em>mouseevent</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred in the y axis.</p>
<p>Returns <em>True</em> | <em>False</em></p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.get_data_interval">
<ttclass="descname">get_data_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.get_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis data limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.get_label_position">
<ttclass="descname">get_label_position</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.get_label_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the label position (left or right)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.get_minpos">
<ttclass="descname">get_minpos</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.get_minpos" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.get_text_widths">
<ttclass="descname">get_text_widths</tt><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.get_text_widths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.get_ticks_position">
<ttclass="descname">get_ticks_position</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.get_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the ticks position (left, right, both or unknown)</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.get_view_interval">
<ttclass="descname">get_view_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.set_data_interval">
<ttclass="descname">set_data_interval</tt><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.set_data_interval" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_default_intervals</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.set_default_intervals" title="Permalink to this definition">¶</a></dt>
<dd><p>set the default limits for the axis interval if they are not mutated</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.set_label_position">
<ttclass="descname">set_label_position</tt><spanclass="sig-paren">(</span><em>position</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.set_label_position" title="Permalink to this definition">¶</a></dt>
<ttclass="descname">set_offset_position</tt><spanclass="sig-paren">(</span><em>position</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.set_offset_position" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.set_ticks_position">
<ttclass="descname">set_ticks_position</tt><spanclass="sig-paren">(</span><em>position</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.set_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the ticks position (left, right, both, default or none)
‘both’ sets the ticks to appear on both positions, but does not
change the tick labels. ‘default’ resets the tick positions to
the default: ticks on both positions, labels at left. ‘none’
can be used if you don’t want any ticks. ‘none’ and ‘both’
<ttclass="descname">set_view_interval</tt><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>ignore</em> is <em>False</em>, the order of vmin, vmax
does not matter; the original axis orientation will
<ttclass="descname">tick_left</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.tick_left" title="Permalink to this definition">¶</a></dt>
<dd><p>use ticks only on left</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YAxis.tick_right">
<ttclass="descname">tick_right</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YAxis.tick_right" title="Permalink to this definition">¶</a></dt>
<p>Contains all the Artists needed to make a Y tick - the tick line,
the label text and the grid line</p>
<p>bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in points</p>
<dlclass="method">
<dtid="matplotlib.axis.YTick.apply_tickdir">
<ttclass="descname">apply_tickdir</tt><spanclass="sig-paren">(</span><em>tickdir</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YTick.apply_tickdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YTick.get_view_interval">
<ttclass="descname">get_view_interval</tt><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YTick.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.axis.YTick.update_position">
<ttclass="descname">update_position</tt><spanclass="sig-paren">(</span><em>loc</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.axis.YTick.update_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the location of tick in data coords with scalar loc</p>