matplotlib.github.com/3.4.3/api/projections_api.html at main · matplotlib/matplotlib.github.com

History

1877 lines (1736 loc) · 153 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.projections — Matplotlib 3.4.3 documentation</title>

title="Search within Matplotlib 3.4.3 documentation"

href="../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.3). For the latest version see <a href="https://matplotlib.org/stable/api/projections_api.html">https://matplotlib.org/stable/api/projections_api.html</a></div>

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.4.3</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

<li><a href="../contents.html">Documentation</a></li>

<li><a href="../gallery/index.html">Examples</a></li>

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="quiver_api.html" title="matplotlib.quiver"

accesskey="N">next</a> |</li>

<a href="_as_gen/matplotlib.pyplot.yticks.html" title="matplotlib.pyplot.yticks"

accesskey="P">previous</a> |</li>

<li><a href="../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate">matplotlib.projections</code></a></li>

</ul>

</div>

<h3><a href="../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#"><code class="docutils literal notranslate">matplotlib.projections</code></a></li>

<li><a class="reference internal" href="#module-matplotlib.projections.polar"><code class="docutils literal notranslate">matplotlib.projections.polar</code></a></li>

</ul>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/projections_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1><code class="docutils literal notranslate">matplotlib.projections</code><a class="headerlink" href="#module-matplotlib.projections" title="Permalink to this headline">¶</a></h1>

class <code class="descclassname">matplotlib.projections.</code><code class="descname">ProjectionRegistry</code><a class="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry">[source]</a><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">object</code></a>

A mapping of registered projection names to projection classes.

<code class="descname">get_projection_class</code>(name)<a class="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry.get_projection_class">[source]</a><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_class" title="Permalink to this definition">¶</a></dt>

<dd>Get a projection class from its name.

</dd></dl>

<code class="descname">get_projection_names</code>()<a class="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry.get_projection_names">[source]</a><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_names" title="Permalink to this definition">¶</a></dt>

<dd>Return the names of all projections currently registered.

</dd></dl>

<code class="descname">register</code>(*projections)<a class="reference internal" href="../_modules/matplotlib/projections.html#ProjectionRegistry.register">[source]</a><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.register" title="Permalink to this definition">¶</a></dt>

<dd>Register a new set of projections.

</dd></dl>

<code class="descclassname">matplotlib.projections.</code><code class="descname">get_projection_class</code>(projection=None)<a class="reference internal" href="../_modules/matplotlib/projections.html#get_projection_class">[source]</a><a class="headerlink" href="#matplotlib.projections.get_projection_class" title="Permalink to this definition">¶</a></dt>

<dd>Get a projection class from its name.

If projection is None, a standard rectilinear projection is returned.

</dd></dl>

<code class="descclassname">matplotlib.projections.</code><code class="descname">get_projection_names</code>()<a class="headerlink" href="#matplotlib.projections.get_projection_names" title="Permalink to this definition">¶</a></dt>

<dd>Return the names of all projections currently registered.

</dd></dl>

<code class="descclassname">matplotlib.projections.</code><code class="descname">register_projection</code>(cls)<a class="reference internal" href="../_modules/matplotlib/projections.html#register_projection">[source]</a><a class="headerlink" href="#matplotlib.projections.register_projection" title="Permalink to this definition">¶</a></dt>

</div>

<h1><code class="docutils literal notranslate">matplotlib.projections.polar</code><a class="headerlink" href="#module-matplotlib.projections.polar" title="Permalink to this headline">¶</a></h1>

class <code class="descclassname">matplotlib.projections.polar.</code><code class="descname">InvertedPolarTransform</code>(axis=None, use_rmin=True, _apply_theta_transforms=True)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#InvertedPolarTransform">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.Transform</code></a>

The inverse of the polar transform, mapping Cartesian

coordinate space x and y back to theta and r.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>shorthand_namestr</dt><dd>A string representing the "name" of the transform. The name carries

no significance other than to improve the readability of

<code class="docutils literal notranslate">str(transform)</code> when DEBUG=True.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">has_inverse</code> = True<a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.has_inverse" title="Permalink to this definition">¶</a></dt>

<code class="descname">input_dims</code> = 2<a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.input_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">inverted</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#InvertedPolarTransform.inverted">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>

<dd>Return the corresponding inverse transformation.

It holds <code class="docutils literal notranslate">x == self.inverted().transform(self.transform(x))</code>.

The return value of this method should be treated as

temporary. An update to self does not cause a corresponding

update to its inverted copy.

</dd></dl>

<code class="descname">output_dims</code> = 2<a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.output_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">transform_non_affine</code>(xy)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#InvertedPolarTransform.transform_non_affine">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>

<dd>Apply only the non-affine part of this transformation.

<code class="docutils literal notranslate">transform(values)</code> is always equivalent to

<code class="docutils literal notranslate">transform_affine(transform_non_affine(values))</code>.

In non-affine transformations, this is generally equivalent to

<code class="docutils literal notranslate">transform(values)</code>. In affine transformations, this is

always a no-op.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>valuesarray</dt><dd>The input values as NumPy array of length <a class="reference internal" href="#matplotlib.projections.polar.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.InvertedPolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a> or

shape (N x <a class="reference internal" href="#matplotlib.projections.polar.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.InvertedPolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a>).

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>array</dt><dd>The output values as NumPy array of length <a class="reference internal" href="#matplotlib.projections.polar.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.InvertedPolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a> or

shape (N x <a class="reference internal" href="#matplotlib.projections.polar.InvertedPolarTransform.output_dims" title="matplotlib.projections.polar.InvertedPolarTransform.output_dims"><code class="xref py py-attr docutils literal notranslate">output_dims</code></a>), depending on the input.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">matplotlib.projections.polar.</code><code class="descname">PolarAffine</code>(scale_transform, limits)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAffine">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAffine" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.Affine2DBase</code></a>

The affine part of the polar projection. Scales the output so

that maximum radius rests on the edge of the axes circle.

limits is the view limit of the data. The only part of

its bounds that is used is the y limits (for the radius limits).

The theta range is handled by the non-affine transform.

<code class="descname">get_matrix</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAffine.get_matrix">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>

<dd>Get the matrix for the affine part of this transform.

</dd></dl>

class <code class="descclassname">matplotlib.projections.polar.</code><code class="descname">PolarAxes</code>(*args, theta_offset=0, theta_direction=1, rlabel_position=22.5, **kwargs)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">matplotlib.axes._axes.Axes</code>

A polar graph projection, where the input dimensions are theta, r.

Theta starts pointing east and goes anti-clockwise.

Build an axes in a figure.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>fig<a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate">Figure</code></a></dt><dd>The axes is build in the <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate">Figure</code></a> fig.

</dd>

<dt>rect[left, bottom, width, height]</dt><dd>The axes is build in the rectangle rect. rect is in

<a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate">Figure</code></a> coordinates.

</dd>

<dt>sharex, sharey<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a>, optional</dt><dd>The x or y <a class="reference internal" href="axis_api.html#module-matplotlib.axis" title="matplotlib.axis"><code class="xref py py-obj docutils literal notranslate">axis</code></a> is shared with the x or

y axis in the input <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a>.

</dd>

<dt>frameonbool, default: True</dt><dd>Whether the axes frame is visible.

</dd>

<dt>box_aspectfloat, optional</dt><dd>Set a fixed aspect for the axes box, i.e. the ratio of height to

width. See <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_box_aspect.html#matplotlib.axes.Axes.set_box_aspect" title="matplotlib.axes.Axes.set_box_aspect"><code class="xref py py-obj docutils literal notranslate">set_box_aspect</code></a> for details.

</dd>

<dt>**kwargs</dt><dd>Other optional keyword arguments:

</colgroup>

<tr class="row-odd"><th class="head">Property</th>

<th class="head">Description</th>

</tr>

</thead>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_adjustable.html#matplotlib.axes.Axes.set_adjustable" title="matplotlib.axes.Axes.set_adjustable"><code class="xref py py-meth docutils literal notranslate">adjustable</code></a></td>

<td>{'box', 'datalim'}</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate">agg_filter</code></a></td>

<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate">alpha</code></a></td>

<td>scalar or None</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_anchor.html#matplotlib.axes.Axes.set_anchor" title="matplotlib.axes.Axes.set_anchor"><code class="xref py py-meth docutils literal notranslate">anchor</code></a></td>

<td>2-tuple of floats or {'C', 'SW', 'S', 'SE', ...}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate">animated</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_aspect.html#matplotlib.axes.Axes.set_aspect" title="matplotlib.axes.Axes.set_aspect"><code class="xref py py-meth docutils literal notranslate">aspect</code></a></td>

<td>{'auto', 'equal'} or float</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_autoscale_on.html#matplotlib.axes.Axes.set_autoscale_on" title="matplotlib.axes.Axes.set_autoscale_on"><code class="xref py py-meth docutils literal notranslate">autoscale_on</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_autoscalex_on.html#matplotlib.axes.Axes.set_autoscalex_on" title="matplotlib.axes.Axes.set_autoscalex_on"><code class="xref py py-meth docutils literal notranslate">autoscalex_on</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_autoscaley_on.html#matplotlib.axes.Axes.set_autoscaley_on" title="matplotlib.axes.Axes.set_autoscaley_on"><code class="xref py py-meth docutils literal notranslate">autoscaley_on</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_axes_locator.html#matplotlib.axes.Axes.set_axes_locator" title="matplotlib.axes.Axes.set_axes_locator"><code class="xref py py-meth docutils literal notranslate">axes_locator</code></a></td>

<td>Callable[[Axes, Renderer], Bbox]</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_axisbelow.html#matplotlib.axes.Axes.set_axisbelow" title="matplotlib.axes.Axes.set_axisbelow"><code class="xref py py-meth docutils literal notranslate">axisbelow</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_box_aspect.html#matplotlib.axes.Axes.set_box_aspect" title="matplotlib.axes.Axes.set_box_aspect"><code class="xref py py-meth docutils literal notranslate">box_aspect</code></a></td>

<td>float or None</td>

</tr>

</tr>

</tr>

<td>Patch or (Path, Transform) or None</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate">contains</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_facecolor.html#matplotlib.axes.Axes.set_facecolor" title="matplotlib.axes.Axes.set_facecolor"><code class="xref py py-meth docutils literal notranslate">facecolor</code></a> or fc</td>

<td>color</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate">figure</code></a></td>

<td><a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate">Figure</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_frame_on.html#matplotlib.axes.Axes.set_frame_on" title="matplotlib.axes.Axes.set_frame_on"><code class="xref py py-meth docutils literal notranslate">frame_on</code></a></td>

</tr>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate">in_layout</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate">label</code></a></td>

<td>object</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_navigate.html#matplotlib.axes.Axes.set_navigate" title="matplotlib.axes.Axes.set_navigate"><code class="xref py py-meth docutils literal notranslate">navigate</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_navigate_mode.html#matplotlib.axes.Axes.set_navigate_mode" title="matplotlib.axes.Axes.set_navigate_mode"><code class="xref py py-meth docutils literal notranslate">navigate_mode</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate">path_effects</code></a></td>

<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate">AbstractPathEffect</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate">picker</code></a></td>

<td>None or bool or float or callable</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_position.html#matplotlib.axes.Axes.set_position" title="matplotlib.axes.Axes.set_position"><code class="xref py py-meth docutils literal notranslate">position</code></a></td>

<td>[left, bottom, width, height] or <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate">Bbox</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_prop_cycle.html#matplotlib.axes.Axes.set_prop_cycle" title="matplotlib.axes.Axes.set_prop_cycle"><code class="xref py py-meth docutils literal notranslate">prop_cycle</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_rasterization_zorder.html#matplotlib.axes.Axes.set_rasterization_zorder" title="matplotlib.axes.Axes.set_rasterization_zorder"><code class="xref py py-meth docutils literal notranslate">rasterization_zorder</code></a></td>

<td>float or None</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate">rasterized</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate">sketch_params</code></a></td>

<td>(scale: float, length: float, randomness: float)</td>

</tr>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_title.html#matplotlib.axes.Axes.set_title" title="matplotlib.axes.Axes.set_title"><code class="xref py py-meth docutils literal notranslate">title</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate">transform</code></a></td>

<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a></td>

</tr>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate">visible</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xbound.html#matplotlib.axes.Axes.set_xbound" title="matplotlib.axes.Axes.set_xbound"><code class="xref py py-meth docutils literal notranslate">xbound</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xlabel.html#matplotlib.axes.Axes.set_xlabel" title="matplotlib.axes.Axes.set_xlabel"><code class="xref py py-meth docutils literal notranslate">xlabel</code></a></td>

</tr>

<td>(bottom: float, top: float)</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xmargin.html#matplotlib.axes.Axes.set_xmargin" title="matplotlib.axes.Axes.set_xmargin"><code class="xref py py-meth docutils literal notranslate">xmargin</code></a></td>

<td>float greater than -0.5</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xscale.html#matplotlib.axes.Axes.set_xscale" title="matplotlib.axes.Axes.set_xscale"><code class="xref py py-meth docutils literal notranslate">xscale</code></a></td>

<td>{"linear", "log", "symlog", "logit", ...} or <a class="reference internal" href="scale_api.html#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><code class="xref py py-obj docutils literal notranslate">ScaleBase</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xticklabels.html#matplotlib.axes.Axes.set_xticklabels" title="matplotlib.axes.Axes.set_xticklabels"><code class="xref py py-meth docutils literal notranslate">xticklabels</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xticks.html#matplotlib.axes.Axes.set_xticks" title="matplotlib.axes.Axes.set_xticks"><code class="xref py py-meth docutils literal notranslate">xticks</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_ybound.html#matplotlib.axes.Axes.set_ybound" title="matplotlib.axes.Axes.set_ybound"><code class="xref py py-meth docutils literal notranslate">ybound</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_ylabel.html#matplotlib.axes.Axes.set_ylabel" title="matplotlib.axes.Axes.set_ylabel"><code class="xref py py-meth docutils literal notranslate">ylabel</code></a></td>

</tr>

<td>(bottom: float, top: float)</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_ymargin.html#matplotlib.axes.Axes.set_ymargin" title="matplotlib.axes.Axes.set_ymargin"><code class="xref py py-meth docutils literal notranslate">ymargin</code></a></td>

<td>float greater than -0.5</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_yscale.html#matplotlib.axes.Axes.set_yscale" title="matplotlib.axes.Axes.set_yscale"><code class="xref py py-meth docutils literal notranslate">yscale</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_yticklabels.html#matplotlib.axes.Axes.set_yticklabels" title="matplotlib.axes.Axes.set_yticklabels"><code class="xref py py-meth docutils literal notranslate">yticklabels</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_yticks.html#matplotlib.axes.Axes.set_yticks" title="matplotlib.axes.Axes.set_yticks"><code class="xref py py-meth docutils literal notranslate">yticks</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate">zorder</code></a></td>

<td>float</td>

</tr>

</tbody>

</table>

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a></dt><dd>The new <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a> object.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

class <code class="descname">InvertedPolarTransform</code>(axis=None, use_rmin=True, _apply_theta_transforms=True)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>

The inverse of the polar transform, mapping Cartesian

coordinate space x and y back to theta and r.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>shorthand_namestr</dt><dd>A string representing the "name" of the transform. The name carries

no significance other than to improve the readability of

<code class="docutils literal notranslate">str(transform)</code> when DEBUG=True.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">has_inverse</code> = True<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.has_inverse" title="Permalink to this definition">¶</a></dt>

<code class="descname">input_dims</code> = 2<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">inverted</code>()<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>

<dd>Return the corresponding inverse transformation.

It holds <code class="docutils literal notranslate">x == self.inverted().transform(self.transform(x))</code>.

The return value of this method should be treated as

temporary. An update to self does not cause a corresponding

update to its inverted copy.

</dd></dl>

<code class="descname">output_dims</code> = 2<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims" title="Permalink to this definition">¶</a></dt>

<dd>Apply only the non-affine part of this transformation.

<code class="docutils literal notranslate">transform(values)</code> is always equivalent to

<code class="docutils literal notranslate">transform_affine(transform_non_affine(values))</code>.

In non-affine transformations, this is generally equivalent to

<code class="docutils literal notranslate">transform(values)</code>. In affine transformations, this is

always a no-op.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>valuesarray</dt><dd>The input values as NumPy array of length <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a> or

shape (N x <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a>).

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>array</dt><dd>The output values as NumPy array of length <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a> or

shape (N x <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims" title="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.output_dims"><code class="xref py py-attr docutils literal notranslate">output_dims</code></a>), depending on the input.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descname">PolarAffine</code>(scale_transform, limits)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine" title="Permalink to this definition">¶</a></dt>

The affine part of the polar projection. Scales the output so

that maximum radius rests on the edge of the axes circle.

limits is the view limit of the data. The only part of

its bounds that is used is the y limits (for the radius limits).

The theta range is handled by the non-affine transform.

<code class="descname">get_matrix</code>()<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>

<dd>Get the matrix for the affine part of this transform.

</dd></dl>

class <code class="descname">PolarTransform</code>(axis=None, use_rmin=True, _apply_theta_transforms=True)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform" title="Permalink to this definition">¶</a></dt>

The base polar transform. This handles projection theta and

r into Cartesian coordinate space x and y, but does not

perform the ultimate affine transformation into the correct

position.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>shorthand_namestr</dt><dd>A string representing the "name" of the transform. The name carries

no significance other than to improve the readability of

<code class="docutils literal notranslate">str(transform)</code> when DEBUG=True.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">has_inverse</code> = True<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.has_inverse" title="Permalink to this definition">¶</a></dt>

<code class="descname">input_dims</code> = 2<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">inverted</code>()<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.inverted" title="Permalink to this definition">¶</a></dt>

<dd>Return the corresponding inverse transformation.

It holds <code class="docutils literal notranslate">x == self.inverted().transform(self.transform(x))</code>.

The return value of this method should be treated as

temporary. An update to self does not cause a corresponding

update to its inverted copy.

</dd></dl>

<code class="descname">output_dims</code> = 2<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">transform_non_affine</code>(tr)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>

<dd>Apply only the non-affine part of this transformation.

<code class="docutils literal notranslate">transform(values)</code> is always equivalent to

<code class="docutils literal notranslate">transform_affine(transform_non_affine(values))</code>.

In non-affine transformations, this is generally equivalent to

<code class="docutils literal notranslate">transform(values)</code>. In affine transformations, this is

always a no-op.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>valuesarray</dt><dd>The input values as NumPy array of length <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a> or

shape (N x <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a>).

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>array</dt><dd>The output values as NumPy array of length <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a> or

shape (N x <a class="reference internal" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims" title="matplotlib.projections.polar.PolarAxes.PolarTransform.output_dims"><code class="xref py py-attr docutils literal notranslate">output_dims</code></a>), depending on the input.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">transform_path_non_affine</code>(path)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>

<dd>Apply the non-affine part of this transform to <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> path,

returning a new <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>.

<code class="docutils literal notranslate">transform_path(path)</code> is equivalent to

<code class="docutils literal notranslate">transform_path_affine(transform_path_non_affine(values))</code>.

</dd></dl>

class <code class="descname">RadialLocator</code>(base, axes=None)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal notranslate">matplotlib.ticker.Locator</code></a>

Used to locate radius ticks.

Ensures that all ticks are strictly positive. For all other tasks, it

delegates to the base <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-obj docutils literal notranslate">Locator</code></a> (which may be different depending on the

scale of the r-axis).

<code class="descname">nonsingular</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.nonsingular" title="Permalink to this definition">¶</a></dt>

<dd>Adjust a range as needed to avoid singularities.

This method gets called during autoscaling, with <code class="docutils literal notranslate">(v0, v1)</code> set to

the data limits on the axes if the axes contains any data, or

<code class="docutils literal notranslate">(-inf, +inf)</code> if not.

<li>If <code class="docutils literal notranslate">v0 == v1</code> (possibly up to some floating point slop), this

method returns an expanded interval around this value.</li>

<li>If <code class="docutils literal notranslate">(v0, v1) == (-inf, +inf)</code>, this method returns appropriate

default view limits.</li>

<li>Otherwise, <code class="docutils literal notranslate">(v0, v1)</code> is returned without modification.</li>

</ul>

</dd></dl>

<code class="descname">pan</code>(numsteps)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.pan" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

<code class="descname">refresh</code>()<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.refresh" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

<code class="descname">view_limits</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.view_limits" title="Permalink to this definition">¶</a></dt>

<dd>Select a scale for the range from vmin to vmax.

Subclasses should override this method to change locator behaviour.

</dd></dl>

<code class="descname">zoom</code>(direction)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator.zoom" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

class <code class="descname">ThetaFormatter</code><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaFormatter" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate">matplotlib.ticker.Formatter</code></a>

Used to format the theta tick labels. Converts the native

unit of radians into degrees and adds a degree symbol.

</dd></dl>

class <code class="descname">ThetaLocator</code>(base)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator" title="Permalink to this definition">¶</a></dt>

Used to locate theta ticks.

This will work the same as the base locator except in the case that the

view spans the entire circle. In such cases, the previously used default

locations of every 45 degrees are returned.

<code class="descname">pan</code>(numsteps)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.pan" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

<code class="descname">refresh</code>()<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.refresh" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Refresh internal information based on current limits.

Notes

Deprecated since version 3.3.

</div>

</dd></dl>

<code class="descname">view_limits</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.view_limits" title="Permalink to this definition">¶</a></dt>

<dd>Select a scale for the range from vmin to vmax.

Subclasses should override this method to change locator behaviour.

</dd></dl>

<code class="descname">zoom</code>(direction)<a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaLocator.zoom" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

<code class="descname">can_pan</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.can_pan">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_pan" title="Permalink to this definition">¶</a></dt>

<dd>Return whether this axes supports the pan/zoom button functionality.

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.

</dd></dl>

<code class="descname">can_zoom</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.can_zoom">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_zoom" title="Permalink to this definition">¶</a></dt>

<dd>Return whether this axes supports the zoom box button functionality.

Polar axes do not support zoom boxes.

</dd></dl>

<code class="descname">cla</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.cla">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.cla" title="Permalink to this definition">¶</a></dt>

<dd>Clear the axes.

</dd></dl>

<code class="descname">drag_pan</code>(button, key, x, y)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.drag_pan">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.drag_pan" title="Permalink to this definition">¶</a></dt>

<dd>Called when the mouse moves during a pan operation.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>button<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseButton" title="matplotlib.backend_bases.MouseButton"><code class="xref py py-obj docutils literal notranslate">MouseButton</code></a></dt><dd>The pressed mouse button.

</dd>

<dt>keystr or None</dt><dd>The pressed key, if any.

</dd>

<dt>x, yfloat</dt><dd>The mouse coordinates in display coords.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

This is intended to be overridden by new projection types.

</dd></dl>

<code class="descname">draw</code>(renderer, *args, **kwargs)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.draw">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.draw" title="Permalink to this definition">¶</a></dt>

<dd>Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (<a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><code class="xref py py-obj docutils literal notranslate">Artist.get_visible</code></a>

returns False).

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>renderer<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate">RendererBase</code></a> subclass.</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

This method is overridden in the Artist subclasses.

</dd></dl>

<code class="descname">end_pan</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.end_pan">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.end_pan" title="Permalink to this definition">¶</a></dt>

<dd>Called when a pan operation completes (when the mouse button is up.)

Notes

This is intended to be overridden by new projection types.

</dd></dl>

<code class="descname">format_coord</code>(theta, r)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.format_coord">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.format_coord" title="Permalink to this definition">¶</a></dt>

<dd>Return a format string formatting the x, y coordinates.

</dd></dl>

<code class="descname">get_data_ratio</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_data_ratio">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_data_ratio" title="Permalink to this definition">¶</a></dt>

<dd>Return the aspect ratio of the data itself. For a polar plot,

this should always be 1.0

</dd></dl>

<code class="descname">get_rlabel_position</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rlabel_position">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rlabel_position" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>float</dt><dd>The theta position of the radius labels in degrees.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_rmax</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rmax">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rmax" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>float</dt><dd>Outer radial limit.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_rmin</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rmin">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rmin" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>float</dt><dd>The inner radial limit.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_rorigin</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rorigin">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rorigin" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>float</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_rsign</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_rsign">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rsign" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_theta_direction</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_theta_direction">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_direction" title="Permalink to this definition">¶</a></dt>

<dd>Get the direction in which theta increases.

<dt>-1:</dt><dd>Theta increases in the clockwise direction</dd>

<dt>1:</dt><dd>Theta increases in the counterclockwise direction</dd>

</dl>

</dd></dl>

<code class="descname">get_theta_offset</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_theta_offset">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_offset" title="Permalink to this definition">¶</a></dt>

<dd>Get the offset for the location of 0 in radians.

</dd></dl>

<code class="descname">get_thetamax</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_thetamax">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_thetamax" title="Permalink to this definition">¶</a></dt>

<dd>Return the maximum theta limit in degrees.

</dd></dl>

<code class="descname">get_thetamin</code>()<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_thetamin">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_thetamin" title="Permalink to this definition">¶</a></dt>

<dd>Get the minimum theta limit in degrees.

</dd></dl>

<code class="descname">get_xaxis_text1_transform</code>(pad)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_xaxis_text1_transform">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_xaxis_text1_transform" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>transformTransform</dt><dd>The transform used for drawing x-axis labels, which will add

pad_points 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

</dd>

<dt>valign{'center', 'top', 'bottom', 'baseline', 'center_baseline'}</dt><dd>The text vertical alignment.

</dd>

<dt>halign{'center', 'left', 'right'}</dt><dd>The text horizontal alignment.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

This transformation is primarily used by the <a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate">Axis</code></a>

class, and is meant to be overridden by new kinds of projections that

may need to place axis elements in different locations.

</dd></dl>

<code class="descname">get_xaxis_text2_transform</code>(pad)<a class="reference internal" href="../_modules/matplotlib/projections/polar.html#PolarAxes.get_xaxis_text2_transform">[source]</a><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_xaxis_text2_transform" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

projections_api.html

Latest commit

History

projections_api.html

File metadata and controls