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

History

1864 lines (1716 loc) · 170 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.ticker — 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/ticker_api.html">https://matplotlib.org/stable/api/ticker_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="tight_bbox_api.html" title="matplotlib.tight_bbox"

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

<a href="textpath_api.html" title="matplotlib.textpath"

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.ticker</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.ticker</code></a><ul>

<li><a class="reference internal" href="#tick-locating-and-formatting">Tick locating and formatting</a><ul>

<li><a class="reference internal" href="#tick-locating">Tick locating</a></li>

<li><a class="reference internal" href="#tick-formatting">Tick formatting</a></li>

</ul>

</li>

</ul>

</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/ticker_api.rst.txt"

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

</div>

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

<h2>Tick locating and formatting<a class="headerlink" href="#tick-locating-and-formatting" title="Permalink to this headline">¶</a></h2>

This module contains classes for configuring tick locating and formatting.

Generic tick locators and formatters are provided, as well as domain specific

custom ones.

Although the locators know nothing about major or minor ticks, they are used

by the Axis class to support major and minor tick locating and formatting.

<h3>Tick locating<a class="headerlink" href="#tick-locating" title="Permalink to this headline">¶</a></h3>

The Locator class is the base class for all tick locators. The locators

handle autoscaling of the view limits based on the data limits, and the

choosing of tick locations. A useful semi-automatic tick locator is

<a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-obj docutils literal notranslate">MultipleLocator</code></a>. It is initialized with a base, e.g., 10, and it picks

axis limits and ticks that are multiples of that base.

The Locator subclasses defined here are

<dt><a class="reference internal" href="#matplotlib.ticker.AutoLocator" title="matplotlib.ticker.AutoLocator"><code class="xref py py-class docutils literal notranslate">AutoLocator</code></a></dt><dd><a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-obj docutils literal notranslate">MaxNLocator</code></a> with simple defaults. This is the default tick locator for

most plotting.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-class docutils literal notranslate">MaxNLocator</code></a></dt><dd>Finds up to a max number of intervals with ticks at nice locations.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LinearLocator" title="matplotlib.ticker.LinearLocator"><code class="xref py py-class docutils literal notranslate">LinearLocator</code></a></dt><dd>Space ticks evenly from min to max.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-class docutils literal notranslate">LogLocator</code></a></dt><dd>Space ticks logarithmically from min to max.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-class docutils literal notranslate">MultipleLocator</code></a></dt><dd>Ticks and range are a multiple of base; either integer or float.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.FixedLocator" title="matplotlib.ticker.FixedLocator"><code class="xref py py-class docutils literal notranslate">FixedLocator</code></a></dt><dd>Tick locations are fixed.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><code class="xref py py-class docutils literal notranslate">IndexLocator</code></a></dt><dd>Locator for index plots (e.g., where <code class="docutils literal notranslate">x = range(len(y))</code>).</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.NullLocator" title="matplotlib.ticker.NullLocator"><code class="xref py py-class docutils literal notranslate">NullLocator</code></a></dt><dd>No ticks.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.SymmetricalLogLocator" title="matplotlib.ticker.SymmetricalLogLocator"><code class="xref py py-class docutils literal notranslate">SymmetricalLogLocator</code></a></dt><dd>Locator for use with with the symlog norm; works like <a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-obj docutils literal notranslate">LogLocator</code></a> for the

part outside of the threshold and adds 0 if inside the limits.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogitLocator" title="matplotlib.ticker.LogitLocator"><code class="xref py py-class docutils literal notranslate">LogitLocator</code></a></dt><dd>Locator for logit scaling.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.OldAutoLocator" title="matplotlib.ticker.OldAutoLocator"><code class="xref py py-class docutils literal notranslate">OldAutoLocator</code></a></dt><dd>Choose a <a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-obj docutils literal notranslate">MultipleLocator</code></a> and dynamically reassign it for intelligent

ticking during navigation.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.AutoMinorLocator" title="matplotlib.ticker.AutoMinorLocator"><code class="xref py py-class docutils literal notranslate">AutoMinorLocator</code></a></dt><dd>Locator for minor ticks when the axis is linear and the

major ticks are uniformly spaced. Subdivides the major

tick interval into a specified number of minor intervals,

defaulting to 4 or 5 depending on the major interval.</dd>

</dl>

There are a number of locators specialized for date locations - see

the <a class="reference internal" href="dates_api.html#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal notranslate">dates</code></a> module.

You can define your own locator by deriving from Locator. You must

override the <code class="docutils literal notranslate">__call__</code> method, which returns a sequence of locations,

and you will probably want to override the autoscale method to set the

view limits from the data limits.

If you want to override the default locator, use one of the above or a custom

locator and pass it to the x or y axis instance. The relevant methods are:

<div class="highlight-default notranslate"><div class="highlight"><pre>ax.xaxis.set_major_locator(xmajor_locator)

ax.xaxis.set_minor_locator(xminor_locator)

ax.yaxis.set_major_locator(ymajor_locator)

ax.yaxis.set_minor_locator(yminor_locator)

</pre></div>

</div>

The default minor locator is <a class="reference internal" href="#matplotlib.ticker.NullLocator" title="matplotlib.ticker.NullLocator"><code class="xref py py-obj docutils literal notranslate">NullLocator</code></a>, i.e., no minor ticks on by default.

Note

<a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-obj docutils literal notranslate">Locator</code></a> instances should not be used with more than one

<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> or <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>. So instead of:

<div class="highlight-default notranslate"><div class="highlight"><pre>locator = MultipleLocator(5)

ax.xaxis.set_major_locator(locator)

ax2.xaxis.set_major_locator(locator)

</pre></div>

</div>

do the following instead:

<div class="last highlight-default notranslate"><div class="highlight"><pre>ax.xaxis.set_major_locator(MultipleLocator(5))

</pre></div>

</div>

<h3>Tick formatting<a class="headerlink" href="#tick-formatting" title="Permalink to this headline">¶</a></h3>

Tick formatting is controlled by classes derived from Formatter. The formatter

operates on a single tick value and returns a string to the axis.

<dt><a class="reference internal" href="#matplotlib.ticker.NullFormatter" title="matplotlib.ticker.NullFormatter"><code class="xref py py-class docutils literal notranslate">NullFormatter</code></a></dt><dd>No labels on the ticks.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.IndexFormatter" title="matplotlib.ticker.IndexFormatter"><code class="xref py py-class docutils literal notranslate">IndexFormatter</code></a></dt><dd>Set the strings from a list of labels.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.FixedFormatter" title="matplotlib.ticker.FixedFormatter"><code class="xref py py-class docutils literal notranslate">FixedFormatter</code></a></dt><dd>Set the strings manually for the labels.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-class docutils literal notranslate">FuncFormatter</code></a></dt><dd>User defined function sets the labels.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.StrMethodFormatter" title="matplotlib.ticker.StrMethodFormatter"><code class="xref py py-class docutils literal notranslate">StrMethodFormatter</code></a></dt><dd>Use string <a class="reference external" href="https://docs.python.org/3/library/functions.html#format" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">format</code></a> method.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.FormatStrFormatter" title="matplotlib.ticker.FormatStrFormatter"><code class="xref py py-class docutils literal notranslate">FormatStrFormatter</code></a></dt><dd>Use an old-style sprintf format string.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><code class="xref py py-class docutils literal notranslate">ScalarFormatter</code></a></dt><dd>Default formatter for scalars: autopick the format string.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal notranslate">LogFormatter</code></a></dt><dd>Formatter for log axes.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatterExponent" title="matplotlib.ticker.LogFormatterExponent"><code class="xref py py-class docutils literal notranslate">LogFormatterExponent</code></a></dt><dd>Format values for log axis using <code class="docutils literal notranslate">exponent = log_base(value)</code>.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatterMathtext" title="matplotlib.ticker.LogFormatterMathtext"><code class="xref py py-class docutils literal notranslate">LogFormatterMathtext</code></a></dt><dd>Format values for log axis using <code class="docutils literal notranslate">exponent = log_base(value)</code>

using Math text.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatterSciNotation" title="matplotlib.ticker.LogFormatterSciNotation"><code class="xref py py-class docutils literal notranslate">LogFormatterSciNotation</code></a></dt><dd>Format values for log axis using scientific notation.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.LogitFormatter" title="matplotlib.ticker.LogitFormatter"><code class="xref py py-class docutils literal notranslate">LogitFormatter</code></a></dt><dd>Probability formatter.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.EngFormatter" title="matplotlib.ticker.EngFormatter"><code class="xref py py-class docutils literal notranslate">EngFormatter</code></a></dt><dd>Format labels in engineering notation.</dd>

<dt><a class="reference internal" href="#matplotlib.ticker.PercentFormatter" title="matplotlib.ticker.PercentFormatter"><code class="xref py py-class docutils literal notranslate">PercentFormatter</code></a></dt><dd>Format labels as a percentage.</dd>

</dl>

You can derive your own formatter from the Formatter base class by

simply overriding the <code class="docutils literal notranslate">__call__</code> method. The formatter class has

access to the axis view and data limits.

To control the major and minor tick label formats, use one of the

following methods:

<div class="highlight-default notranslate"><div class="highlight"><pre>ax.xaxis.set_major_formatter(xmajor_formatter)

ax.xaxis.set_minor_formatter(xminor_formatter)

ax.yaxis.set_major_formatter(ymajor_formatter)

ax.yaxis.set_minor_formatter(yminor_formatter)

</pre></div>

</div>

In addition to a <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-obj docutils literal notranslate">Formatter</code></a> instance, <a class="reference internal" href="_as_gen/matplotlib.axis.Axis.set_major_formatter.html#matplotlib.axis.Axis.set_major_formatter" title="matplotlib.axis.Axis.set_major_formatter"><code class="xref py py-obj docutils literal notranslate">set_major_formatter</code></a> and

<a class="reference internal" href="_as_gen/matplotlib.axis.Axis.set_minor_formatter.html#matplotlib.axis.Axis.set_minor_formatter" title="matplotlib.axis.Axis.set_minor_formatter"><code class="xref py py-obj docutils literal notranslate">set_minor_formatter</code></a> also accept a <code class="docutils literal notranslate">str</code> or function. <code class="docutils literal notranslate">str</code> input

will be internally replaced with an autogenerated <a class="reference internal" href="#matplotlib.ticker.StrMethodFormatter" title="matplotlib.ticker.StrMethodFormatter"><code class="xref py py-obj docutils literal notranslate">StrMethodFormatter</code></a> with

the input <code class="docutils literal notranslate">str</code>. For function input, a <a class="reference internal" href="#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-obj docutils literal notranslate">FuncFormatter</code></a> with the input

function will be generated and used.

See <a class="reference internal" href="../gallery/ticks_and_spines/major_minor_demo.html">Major and minor ticks</a> for an

example of setting major and minor ticks. See the <a class="reference internal" href="dates_api.html#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal notranslate">matplotlib.dates</code></a>

module for more information and examples of using date locators and formatters.

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

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

Dynamically find major tick positions. This is actually a subclass

of <a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-obj docutils literal notranslate">MaxNLocator</code></a>, with parameters nbins = 'auto'

and steps = [1, 2, 2.5, 5, 10].

To know the values of the non-public parameters, please have a

look to the defaults of <a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-obj docutils literal notranslate">MaxNLocator</code></a>.

</dd></dl>

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

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

Dynamically find minor tick positions based on the positions of

major ticks. The scale must be linear with major ticks evenly spaced.

n is the number of subdivisions of the interval between

major ticks; e.g., n=2 will place a single minor tick midway

between major ticks.

If n is omitted or None, it will be set to 5 or 4.

<code class="descname">tick_values</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#AutoMinorLocator.tick_values">[source]</a><a class="headerlink" href="#matplotlib.ticker.AutoMinorLocator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the values of the located ticks given vmin and vmax.

Note

To get tick locations with the vmin and vmax values defined

automatically for the associated <code class="xref py py-attr docutils literal notranslate">axis</code> simply call

the Locator instance:

<div class="last highlight-default notranslate"><div class="highlight"><pre>>>> print(type(loc))

>>> print(loc())

[1, 2, 3, 4]

</pre></div>

</div>

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">EngFormatter</code>(unit='', places=None, sep=' ', *, usetex=None, useMathText=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#EngFormatter">[source]</a><a class="headerlink" href="#matplotlib.ticker.EngFormatter" title="Permalink to this definition">¶</a></dt>

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

Format axis values using engineering prefixes to represent powers

of 1000, plus a specified unit, e.g., 10 MHz instead of 1e7.

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

<dt>unitstr, default: ""</dt><dd>Unit symbol to use, suitable for use with single-letter

representations of powers of 1000. For example, 'Hz' or 'm'.

</dd>

<dt>placesint, default: None</dt><dd>Precision with which to display the number, specified in

digits after the decimal point (there will be between one

and three digits before the decimal point). If it is None,

the formatting falls back to the floating point format '%g',

which displays up to 6 significant digits, i.e. the equivalent

value for places varies between 0 and 5 (inclusive).

</dd>

<dt>sepstr, default: " "</dt><dd>Separator used between the value and the prefix/unit. For

example, one get '3.14 mV' if <code class="docutils literal notranslate">sep</code> is " " (default) and

'3.14mV' if <code class="docutils literal notranslate">sep</code> is "". Besides the default behavior, some

other useful options may be:

<li><code class="docutils literal notranslate">sep=""</code> to append directly the prefix/unit to the value;</li>

<li><code class="docutils literal notranslate">sep="\N{THIN SPACE}"</code> (<code class="docutils literal notranslate">U+2009</code>);</li>

<li><code class="docutils literal notranslate">sep="\N{NARROW NO-BREAK SPACE}"</code> (<code class="docutils literal notranslate">U+202F</code>);</li>

<li><code class="docutils literal notranslate">sep="\N{NO-BREAK SPACE}"</code> (<code class="docutils literal notranslate">U+00A0</code>).</li>

</ul>

</dd>

<dt>usetexbool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file">rcParams["text.usetex"]</a></code> (default: <code class="docutils literal notranslate">False</code>)</dt><dd>To enable/disable the use of TeX's math mode for rendering the

numbers in the formatter.

</dd>

<dt>useMathTextbool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.formatter.use_mathtext#a-sample-matplotlibrc-file">rcParams["axes.formatter.use_mathtext"]</a></code> (default: <code class="docutils literal notranslate">False</code>)</dt><dd>To enable/disable the use mathtext for rendering the numbers in

the formatter.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">ENG_PREFIXES</code> = {-24: 'y', -21: 'z', -18: 'a', -15: 'f', -12: 'p', -9: 'n', -6: 'µ', -3: 'm', 0: '', 3: 'k', 6: 'M', 9: 'G', 12: 'T', 15: 'P', 18: 'E', 21: 'Z', 24: 'Y'}<a class="headerlink" href="#matplotlib.ticker.EngFormatter.ENG_PREFIXES" title="Permalink to this definition">¶</a></dt>

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

<dd>Format a number in engineering notation, appending a letter

representing the power of 1000 of the original number.

Some examples:

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> format_eng(0) # for self.places = 0

'0'

</pre></div>

</div>

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> format_eng(1000000) # for self.places = 1

'1.0 M'

</pre></div>

</div>

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> format_eng("-1e-6") # for self.places = 2

'-1.00 µ'

</pre></div>

</div>

</dd></dl>

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

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

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

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

property <code class="descname">useMathText</code><a class="headerlink" href="#matplotlib.ticker.EngFormatter.useMathText" title="Permalink to this definition">¶</a></dt>

property <code class="descname">usetex</code><a class="headerlink" href="#matplotlib.ticker.EngFormatter.usetex" title="Permalink to this definition">¶</a></dt>

</dd></dl>

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

Return fixed strings for tick labels based only on position, not value.

Note

<a class="reference internal" href="#matplotlib.ticker.FixedFormatter" title="matplotlib.ticker.FixedFormatter"><code class="xref py py-obj docutils literal notranslate">FixedFormatter</code></a> should only be used together with <a class="reference internal" href="#matplotlib.ticker.FixedLocator" title="matplotlib.ticker.FixedLocator"><code class="xref py py-obj docutils literal notranslate">FixedLocator</code></a>.

Otherwise, the labels may end up in unexpected positions.

</div>

Set the sequence seq of strings that will be used for labels.

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

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

</dd></dl>

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

Tick locations are fixed. If nbins is not None,

the array of possible positions will be subsampled to

keep the number of ticks <= nbins +1.

The subsampling will be done so as to include the smallest

absolute value; for example, if zero is included in the

array of possibilities, then it is guaranteed to be one of

the chosen ticks.

<code class="descname">set_params</code>(nbins=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedLocator.set_params">[source]</a><a class="headerlink" href="#matplotlib.ticker.FixedLocator.set_params" title="Permalink to this definition">¶</a></dt>

<dd>Set parameters within this locator.

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedLocator.tick_values">[source]</a><a class="headerlink" href="#matplotlib.ticker.FixedLocator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the locations of the ticks.

Note

Because the values are fixed, vmin and vmax are not used in this

method.

</div>

</dd></dl>

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

Use an old-style ('%' operator) format string to format the tick.

The format string should have a single variable format (%) in it.

It will be applied to the value (not the position) of the tick.

Negative numeric values will use a dash not a unicode minus,

use mathtext to get a unicode minus by wrappping the format specifier

with $ (e.g. "$%g$").

</dd></dl>

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

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

Create a string based on a tick value and location.

static <code class="descname">fix_minus</code>(s)<a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter.fix_minus">[source]</a><a class="headerlink" href="#matplotlib.ticker.Formatter.fix_minus" title="Permalink to this definition">¶</a></dt>

<dd>Some classes may want to replace a hyphen for minus with the proper

unicode symbol (U+2212) for typographical correctness. This is a

helper method to perform such a replacement when it is enabled via

<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.unicode_minus#a-sample-matplotlibrc-file">rcParams["axes.unicode_minus"]</a></code> (default: <code class="docutils literal notranslate">True</code>).

</dd></dl>

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

<dd>Return the full string representation of the value with the

position unspecified.

</dd></dl>

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

<dd>Return a short string version of the tick value.

Defaults to the position-independent long value.

</dd></dl>

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

<dd>Return the tick labels for all the ticks at once.

</dd></dl>

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

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

<dd>Set the locations of the ticks.

This method is called before computing the tick labels because some

formatters need to know all tick locations to do so.

</dd></dl>

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

Use a user-defined function for formatting.

The function should take in two inputs (a tick value <code class="docutils literal notranslate">x</code> and a

position <code class="docutils literal notranslate">pos</code>), and return a string containing the corresponding

tick label.

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

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

</dd></dl>

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

[Deprecated] Format the position x to the nearest i-th label where <code class="docutils literal notranslate">i = int(x + 0.5)</code>.

Positions where <code class="docutils literal notranslate">i < 0</code> or <code class="docutils literal notranslate">i > len(list)</code> have no tick labels.

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

<dt>labelslist</dt><dd>List of labels.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

Deprecated since version 3.3.

</div>

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">IndexLocator</code>(base, offset)<a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexLocator">[source]</a><a class="headerlink" href="#matplotlib.ticker.IndexLocator" title="Permalink to this definition">¶</a></dt>

Place a tick on every multiple of some base number of points

plotted, e.g., on every 5th point. It is assumed that you are doing

index plotting; i.e., the axis is 0, len(data). This is mainly

useful for x ticks.

Place ticks every base data point, starting at offset.

<code class="descname">set_params</code>(base=None, offset=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexLocator.set_params">[source]</a><a class="headerlink" href="#matplotlib.ticker.IndexLocator.set_params" title="Permalink to this definition">¶</a></dt>

<dd>Set parameters within this locator

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexLocator.tick_values">[source]</a><a class="headerlink" href="#matplotlib.ticker.IndexLocator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the values of the located ticks given vmin and vmax.

Note

To get tick locations with the vmin and vmax values defined

automatically for the associated <code class="xref py py-attr docutils literal notranslate">axis</code> simply call

the Locator instance:

>>> print(loc())

[1, 2, 3, 4]

</pre></div>

</div>

</dd></dl>

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

Determine the tick locations

The first time this function is called it will try to set the

number of ticks to make a nice tick partitioning. Thereafter the

number of ticks will be fixed so that interactive navigation will

be nice

Use presets to set locs based on lom. A dict mapping vmin, vmax->locs

property <code class="descname">numticks</code><a class="headerlink" href="#matplotlib.ticker.LinearLocator.numticks" title="Permalink to this definition">¶</a></dt>

<code class="descname">set_params</code>(numticks=None, presets=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LinearLocator.set_params">[source]</a><a class="headerlink" href="#matplotlib.ticker.LinearLocator.set_params" title="Permalink to this definition">¶</a></dt>

<dd>Set parameters within this locator.

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LinearLocator.tick_values">[source]</a><a class="headerlink" href="#matplotlib.ticker.LinearLocator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the values of the located ticks given vmin and vmax.

Note

To get tick locations with the vmin and vmax values defined

automatically for the associated <code class="xref py py-attr docutils literal notranslate">axis</code> simply call

the Locator instance:

>>> print(loc())

[1, 2, 3, 4]

</pre></div>

</div>

</dd></dl>

<code class="descname">view_limits</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LinearLocator.view_limits">[source]</a><a class="headerlink" href="#matplotlib.ticker.LinearLocator.view_limits" title="Permalink to this definition">¶</a></dt>

<dd>Try to choose the view limits intelligently.

</dd></dl>

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

Determine the tick locations;

Note that the same locator should not be used across multiple

data and view limits.

<code class="descname">MAXTICKS</code> = 1000<a class="headerlink" href="#matplotlib.ticker.Locator.MAXTICKS" title="Permalink to this definition">¶</a></dt>

<code class="descname">nonsingular</code>(v0, v1)<a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.nonsingular">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.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="reference internal" href="../_modules/matplotlib/ticker.html#Locator.pan">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.pan" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Pan numticks (can be positive or negative)

Notes

Deprecated since version 3.3.

</div>

</dd></dl>

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

<dd>Log at WARNING level if locs is longer than <a class="reference internal" href="#matplotlib.ticker.Locator.MAXTICKS" title="matplotlib.ticker.Locator.MAXTICKS"><code class="xref py py-obj docutils literal notranslate">Locator.MAXTICKS</code></a>.

This is intended to be called immediately before returning locs from

<code class="docutils literal notranslate">__call__</code> to inform users in case their Locator returns a huge

number of ticks, causing Matplotlib to run out of memory.

The "strange" name of this method dates back to when it would raise an

exception instead of emitting a log.

</dd></dl>

<code class="descname">refresh</code>()<a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.refresh">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.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">set_params</code>(**kwargs)<a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.set_params">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.set_params" title="Permalink to this definition">¶</a></dt>

<dd>Do nothing, and raise a warning. Any locator class not supporting the

set_params() function will call this.

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.tick_values">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the values of the located ticks given vmin and vmax.

Note

To get tick locations with the vmin and vmax values defined

automatically for the associated <code class="xref py py-attr docutils literal notranslate">axis</code> simply call

the Locator instance:

>>> print(loc())

[1, 2, 3, 4]

</pre></div>

</div>

</dd></dl>

<code class="descname">view_limits</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.view_limits">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.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="reference internal" href="../_modules/matplotlib/ticker.html#Locator.zoom">[source]</a><a class="headerlink" href="#matplotlib.ticker.Locator.zoom" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Zoom in/out on axis; if direction is >0 zoom in, else zoom out.

Notes

Deprecated since version 3.3.

</div>

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatter</code>(base=10.0, labelOnlyBase=False, minor_thresholds=None, linthresh=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogFormatter" title="Permalink to this definition">¶</a></dt>

Base class for formatting ticks on a log or symlog scale.

It may be instantiated directly, or subclassed.

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

<dt>basefloat, default: 10.</dt><dd>Base of the logarithm used in all calculations.

</dd>

<dt>labelOnlyBasebool, default: False</dt><dd>If True, label ticks only at integer powers of base.

This is normally True for major ticks and False for

minor ticks.

</dd>

<dt>minor_thresholds(subset, all), default: (1, 0.4)</dt><dd>If labelOnlyBase is False, these two numbers control

the labeling of ticks that are not at integer powers of

base; normally these are the minor ticks. The controlling

parameter is the log of the axis data range. In the typical

case where base is 10 it is the number of decades spanned

by the axis, so we can call it 'numdec'. If <code class="docutils literal notranslate">numdec <= all</code>,

all minor ticks will be labeled. If <code class="docutils literal notranslate">all < numdec <= subset</code>,

then only a subset of minor ticks will be labeled, so as to

avoid crowding. If <code class="docutils literal notranslate">numdec > subset</code> then no minor ticks will

be labeled.

</dd>

<dt>linthreshNone or float, default: None</dt><dd>If a symmetric log scale is in use, its <code class="docutils literal notranslate">linthresh</code>

parameter must be supplied here.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

The <a class="reference internal" href="#matplotlib.ticker.LogFormatter.set_locs" title="matplotlib.ticker.LogFormatter.set_locs"><code class="xref py py-obj docutils literal notranslate">set_locs</code></a> method must be called to enable the subsetting

logic controlled by the <code class="docutils literal notranslate">minor_thresholds</code> parameter.

In some cases such as the colorbar, there is no distinction between

major and minor ticks; the tick locations might be set manually,

or by a locator that puts ticks at integer powers of base and

at intermediate locations. For this situation, disable the

minor_thresholds logic by using <code class="docutils literal notranslate">minor_thresholds=(np.inf, np.inf)</code>,

so that all ticks will be labeled.

To disable labeling of minor ticks when 'labelOnlyBase' is False,

use <code class="docutils literal notranslate">minor_thresholds=(0, 0)</code>. This is the default for the

"classic" style.

Examples

To label a subset of minor ticks when the view limits span up

to 2 decades, and all of the ticks when zoomed in to 0.5 decades

or less, use <code class="docutils literal notranslate">minor_thresholds=(2, 0.5)</code>.

To label all minor ticks when the view limits span up to 1.5

decades, use <code class="docutils literal notranslate">minor_thresholds=(1.5, 1.5)</code>.

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

<dd>Change the base for labeling.

Warning

Should always match the base used for <a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-class docutils literal notranslate">LogLocator</code></a>

</div>

</dd></dl>

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

<dd>Return the full string representation of the value with the

position unspecified.

</dd></dl>

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

<dd>Return a short string version of the tick value.

Defaults to the position-independent long value.

</dd></dl>

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

<dd>Switch minor tick labeling on or off.

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

<dt>labelOnlyBasebool</dt><dd>If True, label ticks only at integer powers of base.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">set_locs</code>(locs=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.set_locs">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.set_locs" title="Permalink to this definition">¶</a></dt>

<dd>Use axis view limits to control which ticks are labeled.

The locs parameter is ignored in the present algorithm.

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterExponent</code>(base=10.0, labelOnlyBase=False, minor_thresholds=None, linthresh=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatterExponent">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogFormatterExponent" title="Permalink to this definition">¶</a></dt>

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

Format values for log axis using <code class="docutils literal notranslate">exponent = log_base(value)</code>.

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterMathtext</code>(base=10.0, labelOnlyBase=False, minor_thresholds=None, linthresh=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatterMathtext">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogFormatterMathtext" title="Permalink to this definition">¶</a></dt>

Format values for log axis using <code class="docutils literal notranslate">exponent = log_base(value)</code>.

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterSciNotation</code>(base=10.0, labelOnlyBase=False, minor_thresholds=None, linthresh=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatterSciNotation">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogFormatterSciNotation" title="Permalink to this definition">¶</a></dt>

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

Format values following scientific notation in a logarithmic axis.

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">LogLocator</code>(base=10.0, subs=(1.0), numdecs=4, numticks=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogLocator">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogLocator" title="Permalink to this definition">¶</a></dt>

Determine the tick locations for log axes

Place ticks on the locations : subs[j] * base**i

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

<dt>basefloat, default: 10.0</dt><dd>The base of the log used, so ticks are placed at <code class="docutils literal notranslate">base**n</code>.

</dd>

<dt>subsNone or str or sequence of float, default: (1.0,)</dt><dd>Gives the multiples of integer powers of the base at which

to place ticks. The default places ticks only at

integer powers of the base.

The permitted string values are <code class="docutils literal notranslate">'auto'</code> and <code class="docutils literal notranslate">'all'</code>,

both of which use an algorithm based on the axis view

limits to determine whether and how to put ticks between

integer powers of the base. With <code class="docutils literal notranslate">'auto'</code>, ticks are

placed only between integer powers; with <code class="docutils literal notranslate">'all'</code>, the

integer powers are included. A value of None is

equivalent to <code class="docutils literal notranslate">'auto'</code>.

</dd>

<dt>numticksNone or int, default: None</dt><dd>The maximum number of ticks to allow on a given axis. The default

of <code class="docutils literal notranslate">None</code> will try to choose intelligently as long as this

Locator has already been assigned to an axis using

<a class="reference internal" href="_as_gen/matplotlib.axis.Axis.get_tick_space.html#matplotlib.axis.Axis.get_tick_space" title="matplotlib.axis.Axis.get_tick_space"><code class="xref py py-obj docutils literal notranslate">get_tick_space</code></a>, but otherwise falls back to 9.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd>Set the log base (major tick every <code class="docutils literal notranslate">base**i</code>, i integer).

</dd></dl>

<code class="descname">nonsingular</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogLocator.nonsingular">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogLocator.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>

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">set_params</code>(base=None, subs=None, numdecs=None, numticks=None)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogLocator.set_params">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogLocator.set_params" title="Permalink to this definition">¶</a></dt>

<dd>Set parameters within this locator.

</dd></dl>

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

<dd>Set the minor ticks for the log scaling every <code class="docutils literal notranslate">base**i*subs[j]</code>.

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogLocator.tick_values">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogLocator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the values of the located ticks given vmin and vmax.

Note

To get tick locations with the vmin and vmax values defined

automatically for the associated <code class="xref py py-attr docutils literal notranslate">axis</code> simply call

the Locator instance:

>>> print(loc())

[1, 2, 3, 4]

</pre></div>

</div>

</dd></dl>

<code class="descname">view_limits</code>(vmin, vmax)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogLocator.view_limits">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogLocator.view_limits" title="Permalink to this definition">¶</a></dt>

<dd>Try to choose the view limits intelligently.

</dd></dl>

class <code class="descclassname">matplotlib.ticker.</code><code class="descname">LogitFormatter</code>(*, use_overline=False, one_half='\x0crac{1}{2}', minor=False, minor_threshold=25, minor_number=6)<a class="reference internal" href="../_modules/matplotlib/ticker.html#LogitFormatter">[source]</a><a class="headerlink" href="#matplotlib.ticker.LogitFormatter" title="Permalink to this definition">¶</a></dt>

Probability formatter (using Math text).

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

<dt>use_overlinebool, default: False</dt><dd>If x > 1/2, with x = 1-v, indicate if x should be displayed as

$overline{v}$. The default is to display $1-v$.

</dd>

<dt>one_halfstr, default: r"frac{1}{2}"</dt><dd>The string used to represent 1/2.

</dd>

<dt>minorbool, default: False</dt><dd>Indicate if the formatter is formatting minor ticks or not.

Basically minor ticks are not labelled, except when only few ticks

are provided, ticks with most space with neighbor ticks are

labelled. See other parameters to change the default behavior.

</dd>

<dt>minor_thresholdint, default: 25</dt><dd>Maximum number of locs for labelling some minor ticks. This

parameter have no effect if minor is False.

</dd>

<dt>minor_numberint, default: 6</dt><dd>Number of ticks which are labelled when the number of ticks is

below the threshold.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd>Return a short string version of the tick value.

Defaults to the position-independent long value.

</dd></dl>

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

<dd>Set the locations of the ticks.

This method is called before computing the tick labels because some

formatters need to know all tick locations to do so.

</dd></dl>

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

<dd>Set the number of minor ticks to label when some minor ticks are

labelled.

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

ticker_api.html

Latest commit

History

ticker_api.html

File metadata and controls