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 (v3.2.0). For the latest version see <ahref="https://matplotlib.org/stable/api/projections_api.html">https://matplotlib.org/stable/api/projections_api.html</a></div>
<spanid="matplotlib-projections"></span><h1><codeclass="docutils literal notranslate"><spanclass="pre">matplotlib.projections</span></code><aclass="headerlink" href="#module-matplotlib.projections" title="Permalink to this headline">¶</a></h1>
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">ProjectionRegistry</code><aclass="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.ProjectionRegistry" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_projection_class</code><spanclass="sig-paren">(</span><em>self</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry.get_projection_class"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a projection class from its <em>name</em>.</p>
<codeclass="descname">get_projection_names</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry.get_projection_names"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names of all projections currently registered.</p>
<codeclass="descname">register</code><spanclass="sig-paren">(</span><em>self</em>, <em>*projections</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry.register"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.ProjectionRegistry.register" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">get_projection_class</code><spanclass="sig-paren">(</span><em>projection=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections.html#get_projection_class"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.get_projection_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a projection class from its name.</p>
<p>If <em>projection</em> is None, a standard rectilinear projection is returned.</p>
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">get_projection_names</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names of all projections currently registered.</p>
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">process_projection_requirements</code><spanclass="sig-paren">(</span><em>figure</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections.html#process_projection_requirements"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.process_projection_requirements" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.1: </span></p>
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">register_projection</code><spanclass="sig-paren">(</span><em>cls</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections.html#register_projection"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.register_projection" title="Permalink to this definition">¶</a></dt>
<spanid="matplotlib-projections-polar"></span><h1><codeclass="docutils literal notranslate"><spanclass="pre">matplotlib.projections.polar</span></code><aclass="headerlink" href="#module-matplotlib.projections.polar" title="Permalink to this headline">¶</a></h1>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#InvertedPolarTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = False</em><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>self</em>, <em>xy</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#InvertedPolarTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>values</strong><spanclass="classifier">array</span></dt><dd><p>The output values as NumPy array of length <aclass="reference internal" href="#matplotlib.projections.polar.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.InvertedPolarTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a> or
shape (N x <aclass="reference internal" href="#matplotlib.projections.polar.InvertedPolarTransform.output_dims" title="matplotlib.projections.polar.InvertedPolarTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.projections.polar.PolarAffine">
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">PolarAffine</code><spanclass="sig-paren">(</span><em>scale_transform</em>, <em>limits</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAffine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAffine" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_matrix</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAffine.get_matrix"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the Affine transformation array for the affine part
of this transform.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.projections.polar.PolarAxes">
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">PolarAxes</code><spanclass="sig-paren">(</span><em>*args</em>, <em>theta_offset=0</em>, <em>theta_direction=1</em>, <em>rlabel_position=22.5</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes" title="Permalink to this definition">¶</a></dt>
<dt><strong>fig</strong><spanclass="classifier"><aclass="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Figure</span></code></a></span></dt><dd><p>The axes is build in the <aclass="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Figure</span></code></a><em>fig</em>.</p>
</dd>
<dt><strong>rect</strong><spanclass="classifier">[left, bottom, width, height]</span></dt><dd><p>The axes is build in the rectangle <em>rect</em>. <em>rect</em> is in
<dt><strong>sharex, sharey</strong><spanclass="classifier"><aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axes</span></code></a>, optional</span></dt><dd><p>The x or y <aclass="reference internal" href="axis_api.html#module-matplotlib.axis" title="matplotlib.axis"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">axis</span></code></a> is shared with the x or
y axis in the input <aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axes</span></code></a>.</p>
</dd>
<dt><strong>frameon</strong><spanclass="classifier">bool, optional</span></dt><dd><p>True means that the axes frame is visible.</p>
<emclass="property">class </em><codeclass="descname">InvertedPolarTransform</code><spanclass="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em>, <em>_apply_theta_transforms=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = False</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>self</em>, <em>xy</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<emclass="property">class </em><codeclass="descname">PolarAffine</code><spanclass="sig-paren">(</span><em>scale_transform</em>, <em>limits</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_matrix</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the Affine transformation array for the affine part
<emclass="property">class </em><codeclass="descname">PolarTransform</code><spanclass="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em>, <em>_apply_theta_transforms=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = False</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>self</em>, <em>tr</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<codeclass="descname">transform_path_non_affine</code><spanclass="sig-paren">(</span><em>self</em>, <em>path</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a path, transformed only by the non-affine
<emclass="property">class </em><codeclass="descname">RadialLocator</code><spanclass="sig-paren">(</span><em>base</em>, <em>axes=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator" title="Permalink to this definition">¶</a></dt>
<p>Ensures that all ticks are strictly positive. For all other
tasks, it delegates to the base
<aclass="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Locator</span></code></a> (which may be different
depending on the scale of the <em>r</em>-axis.</p>
<codeclass="descname">autoscale</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.2: </span></p>
<codeclass="descname">nonsingular</code><spanclass="sig-paren">(</span><em>self</em>, <em>vmin</em>, <em>vmax</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.nonsingular" title="Permalink to this definition">¶</a></dt>
<dd><p>Adjust a range as needed to avoid singularities.</p>
<p>This method gets called during autoscaling, with <codeclass="docutils literal notranslate"><spanclass="pre">(v0,</span><spanclass="pre">v1)</span></code> set to
the data limits on the axes if the axes contains any data, or
<codeclass="docutils literal notranslate"><spanclass="pre">(-inf,</span><spanclass="pre">+inf)</span></code> if not.</p>
<ulclass="simple">
<li>If <codeclass="docutils literal notranslate"><spanclass="pre">v0</span><spanclass="pre">==</span><spanclass="pre">v1</span></code> (possibly up to some floating point slop), this
method returns an expanded interval around this value.</li>
<li>If <codeclass="docutils literal notranslate"><spanclass="pre">(v0,</span><spanclass="pre">v1)</span><spanclass="pre">==</span><spanclass="pre">(-inf,</span><spanclass="pre">+inf)</span></code>, this method returns appropriate
default view limits.</li>
<li>Otherwise, <codeclass="docutils literal notranslate"><spanclass="pre">(v0,</span><spanclass="pre">v1)</span></code> is returned without modification.</li>
<codeclass="descname">pan</code><spanclass="sig-paren">(</span><em>self</em>, <em>numsteps</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Pan numticks (can be positive or negative)</p>
<codeclass="descname">refresh</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>Refresh internal information based on current limits.</p>
<codeclass="descname">view_limits</code><spanclass="sig-paren">(</span><em>self</em>, <em>vmin</em>, <em>vmax</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Select a scale for the range from vmin to vmax.</p>
<p>Subclasses should override this method to change locator behaviour.</p>
<codeclass="descname">zoom</code><spanclass="sig-paren">(</span><em>self</em>, <em>direction</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Zoom in/out on axis; if direction is >0 zoom in, else zoom out</p>
<emclass="property">class </em><codeclass="descname">ThetaFormatter</code><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaFormatter" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">ThetaLocator</code><spanclass="sig-paren">(</span><em>base</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">autoscale</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.2: </span></p>
<codeclass="descname">pan</code><spanclass="sig-paren">(</span><em>self</em>, <em>numsteps</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Pan numticks (can be positive or negative)</p>
<codeclass="descname">refresh</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>Refresh internal information based on current limits.</p>
<codeclass="descname">set_axis</code><spanclass="sig-paren">(</span><em>self</em>, <em>axis</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.set_axis" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">view_limits</code><spanclass="sig-paren">(</span><em>self</em>, <em>vmin</em>, <em>vmax</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Select a scale for the range from vmin to vmax.</p>
<p>Subclasses should override this method to change locator behaviour.</p>
<codeclass="descname">zoom</code><spanclass="sig-paren">(</span><em>self</em>, <em>direction</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Zoom in/out on axis; if direction is >0 zoom in, else zoom out</p>
<codeclass="descname">can_pan</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.can_pan"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the pan/zoom button functionality.</p>
<p>For polar axes, this is slightly misleading. Both panning and
zooming are performed by the same button. Panning is performed
in azimuth while zooming is done along the radial.</p>
<codeclass="descname">can_zoom</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.can_zoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the zoom box button functionality.</p>
<codeclass="descname">cla</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.cla"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.cla" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.draw" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">end_pan</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.end_pan"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.end_pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when a pan operation completes (when the mouse button
is up.)</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">Intended to be overridden by new projection types.</p>
<codeclass="descname">format_coord</code><spanclass="sig-paren">(</span><em>self</em>, <em>theta</em>, <em>r</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.format_coord"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.format_coord" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a format string formatting the coordinate using Unicode
<codeclass="descname">get_data_ratio</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_data_ratio"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_data_ratio" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the aspect ratio of the data itself. For a polar plot,
<codeclass="descname">get_rlabel_position</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rlabel_position"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rlabel_position" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_rmax</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rmax"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rmax" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_rmin</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rmin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rmin" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_rorigin</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rorigin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rorigin" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_rsign</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rsign"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rsign" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_theta_direction</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_theta_direction"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_direction" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the direction in which theta increases.</p>
<dlclass="docutils">
<dt>-1:</dt><dd>Theta increases in the clockwise direction</dd>
<dt>1:</dt><dd>Theta increases in the counterclockwise direction</dd>
<codeclass="descname">get_theta_offset</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_theta_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the offset for the location of 0 in radians.</p>
<codeclass="descname">get_thetamax</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_thetamax"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_thetamax" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the maximum theta limit in degrees.</p>
<codeclass="descname">get_thetamin</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_thetamin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_thetamin" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the minimum theta limit in degrees.</p>
<codeclass="descname">get_xaxis_text1_transform</code><spanclass="sig-paren">(</span><em>self</em>, <em>pad</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_xaxis_text1_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_xaxis_text1_transform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>transform</strong><spanclass="classifier">Transform</span></dt><dd><p>The transform used for drawing x-axis labels, which will add
<em>pad_points</em> of padding (in points) between the axes and the label.
The x-direction is in data coordinates and the y-direction is in
axis corrdinates</p>
</dd>
<dt><strong>valign</strong><spanclass="classifier">{'center', 'top', 'bottom', 'baseline', 'center_baseline'}</span></dt><dd><p>The text vertical alignment.</p>
</dd>
<dt><strong>halign</strong><spanclass="classifier">{'center', 'left', 'right'}</span></dt><dd><p>The text horizontal alignment.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>This transformation is primarily used by the <aclass="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axis</span></code></a>
class, and is meant to be overridden by new kinds of projections that
may need to place axis elements in different locations.</p>