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.0.2). For the latest version see <ahref="https://matplotlib.org/stable/api/projections_api.html">https://matplotlib.org/stable/api/projections_api.html</a></div>
<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>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><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>Get a list of the names of all projections currently registered.</p>
<codeclass="descname">register</code><spanclass="sig-paren">(</span><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="reference internal" href="../_modules/matplotlib/projections.html#get_projection_names"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of acceptable projection names.</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>
<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><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>
<p>The return value of this method should be treated as
temporary. An update to <em>self</em> does not cause a corresponding
<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>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
<p>In non-affine transformations, this is generally equivalent to
<codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <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>) and
returns a numpy array of 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>).</p>
<p>Alternatively, accepts a 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>
and returns a numpy array of length <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>.</p>
</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><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>
<dd><pclass="first last">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>
<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>
<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><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>
<p>The return value of this method should be treated as
temporary. An update to <em>self</em> does not cause a corresponding
<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>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
<p>In non-affine transformations, this is generally equivalent to
<codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a>) and
returns a numpy array of shape (N x <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>).</p>
<p>Alternatively, accepts a numpy array of length <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a>
and returns a numpy array of length <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>.</p>
<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><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>
<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><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>
<p>The return value of this method should be treated as
temporary. An update to <em>self</em> does not cause a corresponding
<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>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
<p>In non-affine transformations, this is generally equivalent to
<codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a>) and
returns a numpy array of shape (N x <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>).</p>
<p>Alternatively, accepts a numpy array of length <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a>
and returns a numpy array of length <aclass="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>.</p>
<codeclass="descname">transform_path_non_affine</code><spanclass="sig-paren">(</span><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><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">pan</code><spanclass="sig-paren">(</span><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><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 lim</p>
<codeclass="descname">view_limits</code><spanclass="sig-paren">(</span><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>Normally this method is overridden by subclasses to
<codeclass="descname">zoom</code><spanclass="sig-paren">(</span><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><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">pan</code><spanclass="sig-paren">(</span><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><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 lim</p>
<codeclass="descname">set_axis</code><spanclass="sig-paren">(</span><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>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>Normally this method is overridden by subclasses to
<codeclass="descname">zoom</code><spanclass="sig-paren">(</span><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><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><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><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>*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><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>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><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><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><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><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><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_theta_direction</code><spanclass="sig-paren">(</span><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><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><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>
<codeclass="descname">get_thetamin</code><spanclass="sig-paren">(</span><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>
<codeclass="descname">get_xaxis_text1_transform</code><spanclass="sig-paren">(</span><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>
<dd><p>Get the transformation used for drawing x-axis labels, which
will add the given amount of padding (in points) between the
axes and the label. The x-direction is in data coordinates
and the y-direction is in axis coordinates. Returns a
<p>where <em>valign</em> and <em>halign</em> are requested alignments for the
text.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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-class 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
<codeclass="descname">get_xaxis_text2_transform</code><spanclass="sig-paren">(</span><em>pad</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_xaxis_text2_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_xaxis_text2_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transformation used for drawing the secondary x-axis
labels, which will add the given amount of padding (in points)
between the axes and the label. The x-direction is in data
coordinates and the y-direction is in axis coordinates.
<p>where <em>valign</em> and <em>halign</em> are requested alignments for the
text.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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-class 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
<codeclass="descname">get_xaxis_transform</code><spanclass="sig-paren">(</span><em>which='grid'</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_xaxis_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_xaxis_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transformation used for drawing x-axis labels, ticks
and gridlines. The x-direction is in data coordinates and the
y-direction is in axis coordinates.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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-class 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
<codeclass="descname">get_yaxis_text1_transform</code><spanclass="sig-paren">(</span><em>pad</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_yaxis_text1_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_yaxis_text1_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transformation used for drawing y-axis labels, which
will add the given amount of padding (in points) between the
axes and the label. The x-direction is in axis coordinates
and the y-direction is in data coordinates. Returns a 3-tuple
<p>where <em>valign</em> and <em>halign</em> are requested alignments for the
text.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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-class 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
<codeclass="descname">get_yaxis_text2_transform</code><spanclass="sig-paren">(</span><em>pad</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_yaxis_text2_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_yaxis_text2_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transformation used for drawing the secondary y-axis
labels, which will add the given amount of padding (in points)
between the axes and the label. The x-direction is in axis
coordinates and the y-direction is in data coordinates.
<p>where <em>valign</em> and <em>halign</em> are requested alignments for the
text.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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-class 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
<codeclass="descname">get_yaxis_transform</code><spanclass="sig-paren">(</span><em>which='grid'</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_yaxis_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_yaxis_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transformation used for drawing y-axis labels, ticks
and gridlines. The x-direction is in axis coordinates and the
y-direction is in data coordinates.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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-class 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
<codeclass="descname">name</code><emclass="property"> = 'polar'</em><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.name" title="Permalink to this definition">¶</a></dt>
<dt><strong>radii</strong><spanclass="classifier-delimiter">:</span><spanclass="classifier">tuple with floats</span></dt>
<dd><pclass="first last">The radii for the radial gridlines</p>
</dd>
<dt><strong>labels</strong><spanclass="classifier-delimiter">:</span><spanclass="classifier">tuple with strings or None</span></dt>
<dd><pclass="first last">The labels to use at each radial gridline. The
<aclass="reference internal" href="ticker_api.html#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">matplotlib.ticker.ScalarFormatter</span></code></a> will be used if None.</p>
<codeclass="descname">set_rlabel_position</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.set_rlabel_position"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_rlabel_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the theta position of the radius labels.</p>