matplotlib.github.com/3.3.0/_modules/matplotlib/axis.html at main · matplotlib/matplotlib.github.com

History

2666 lines (2283 loc) · 382 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.axis — Matplotlib 3.3.0 documentation</title>

title="Search within Matplotlib 3.3.0 documentation"

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

</head><body>

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

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.3.0</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>

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

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

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

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.axis</h1><div class="highlight"><pre>

"""

Classes for the ticks and x and y axis.

"""

import datetime

import functools

import logging

import numpy as np

import matplotlib as mpl

import matplotlib.artist as martist

import matplotlib.cbook as cbook

import matplotlib.lines as mlines

import matplotlib.scale as mscale

import matplotlib.text as mtext

import matplotlib.ticker as mticker

import matplotlib.transforms as mtransforms

import matplotlib.units as munits

_log = logging.getLogger(__name__)

GRIDLINE_INTERPOLATION_STEPS = 180

# This list is being used for compatibility with Axes.grid, which

# allows all Line2D kwargs.

_line_inspector = martist.ArtistInspector(mlines.Line2D)

_line_param_names = _line_inspector.get_setters()

_line_param_aliases = [list(d)[0] for d in _line_inspector.aliasd.values()]

_gridline_param_names = ['grid_' + name

for name in _line_param_names + _line_param_aliases]

<div class="viewcode-block" id="Tick"><a class="viewcode-back" href="../../api/axis_api.html#matplotlib.axis.Tick">[docs]</a>class Tick(martist.Artist):

"""

Abstract base class for the axis ticks, grid lines and labels.

Ticks mark a position on an Axis. They contain two lines as markers and

two labels; one each for the bottom and top positions (in case of an

`.XAxis`) or for the left and right positions (in case of a `.YAxis`).

Attributes

----------

tick1line : `.Line2D`

The left/bottom tick marker.

tick2line : `.Line2D`

The right/top tick marker.

gridline : `.Line2D`

The grid line associated with the label position.

label1 : `.Text`

The left/bottom tick label.

label2 : `.Text`

The right/top tick label.

"""

@cbook._delete_parameter("3.3", "label")

def __init__(self, axes, loc, label=None,

size=None, # points

width=None,

color=None,

tickdir=None,

pad=None,

labelsize=None,

labelcolor=None,

zorder=None,

gridOn=None, # defaults to axes.grid depending on

# axes.grid.which

tick1On=True,

tick2On=True,

label1On=True,

label2On=False,

major=True,

labelrotation=0,

grid_color=None,

grid_linestyle=None,

grid_linewidth=None,

grid_alpha=None,

**kw # Other Line2D kwargs applied to gridlines.

):

"""

bbox is the Bound2D bounding box in display coords of the Axes

loc is the tick location in data coords

size is the tick size in points

"""

martist.Artist.__init__(self)

if gridOn is None:

if major and (mpl.rcParams['axes.grid.which']

in ('both', 'major')):

gridOn = mpl.rcParams['axes.grid']

elif (not major) and (mpl.rcParams['axes.grid.which']

in ('both', 'minor')):

else:

gridOn = False

self.set_figure(axes.figure)

self.axes = axes

name = self.__name__.lower()

self._loc = loc

self._major = major

major_minor = "major" if major else "minor"

if size is None:

size = mpl.rcParams[f"{name}.{major_minor}.size"]

self._size = size

if width is None:

width = mpl.rcParams[f"{name}.{major_minor}.width"]

self._width = width

if color is None:

color = mpl.rcParams[f"{name}.color"]

if pad is None:

pad = mpl.rcParams[f"{name}.{major_minor}.pad"]

self._base_pad = pad

if labelcolor is None:

labelcolor = mpl.rcParams[f"{name}.color"]

if labelsize is None:

labelsize = mpl.rcParams[f"{name}.labelsize"]

self._set_labelrotation(labelrotation)

if zorder is None:

if major:

zorder = mlines.Line2D.zorder + 0.01

else:

zorder = mlines.Line2D.zorder

self._zorder = zorder

if grid_color is None:

grid_color = mpl.rcParams["grid.color"]

if grid_linestyle is None:

grid_linestyle = mpl.rcParams["grid.linestyle"]

if grid_linewidth is None:

grid_linewidth = mpl.rcParams["grid.linewidth"]

if grid_alpha is None:

grid_alpha = mpl.rcParams["grid.alpha"]

grid_kw = {k[5:]: v for k, v in kw.items()}

self.apply_tickdir(tickdir)

self.tick1line = mlines.Line2D(

[], [],

color=color, linestyle="none", zorder=zorder, visible=tick1On,

markeredgecolor=color, markersize=size, markeredgewidth=width,

)

self.tick2line = mlines.Line2D(

[], [],

)

self.gridline = mlines.Line2D(

[], [],

color=grid_color, alpha=grid_alpha, visible=gridOn,

linestyle=grid_linestyle, linewidth=grid_linewidth, marker="",

**grid_kw,

)

self.gridline.get_path()._interpolation_steps = \

GRIDLINE_INTERPOLATION_STEPS

self.label1 = mtext.Text(

np.nan, np.nan,

fontsize=labelsize, color=labelcolor, visible=label1On)

self.label2 = mtext.Text(

np.nan, np.nan,

for meth, attr in [("_get_tick1line", "tick1line"),

("_get_tick2line", "tick2line"),

("_get_gridline", "gridline"),

("_get_text1", "label1"),

("_get_text2", "label2")]:

overridden_method = cbook._deprecate_method_override(

getattr(__class__, meth), self, since="3.3", message="Relying "

f"on {meth} to initialize Tick.{attr} is deprecated since "

f"%(since)s and will not work %(removal)s; please directly "

f"set the attribute in the subclass' __init__ instead.")

if overridden_method:

setattr(self, attr, overridden_method())

for artist in [self.tick1line, self.tick2line, self.gridline,

self.label1, self.label2]:

self._set_artist_props(artist)

self.update_position(loc)

@property

@cbook.deprecated("3.1", alternative="Tick.label1", pending=True)

def label(self):

return self.label1

def _set_labelrotation(self, labelrotation):

if isinstance(labelrotation, str):

mode = labelrotation

angle = 0

elif isinstance(labelrotation, (tuple, list)):

mode, angle = labelrotation

else:

mode = 'default'

angle = labelrotation

cbook._check_in_list(['auto', 'default'], labelrotation=mode)

self._labelrotation = (mode, angle)

<div class="viewcode-block" id="Tick.apply_tickdir"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.apply_tickdir.html#matplotlib.axis.Tick.apply_tickdir">[docs]</a> def apply_tickdir(self, tickdir):

"""Calculate ``self._pad`` and ``self._tickmarkers``."""</div>

<div class="viewcode-block" id="Tick.get_tickdir"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.get_tickdir.html#matplotlib.axis.Tick.get_tickdir">[docs]</a> def get_tickdir(self):

return self._tickdir</div>

<div class="viewcode-block" id="Tick.get_tick_padding"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.get_tick_padding.html#matplotlib.axis.Tick.get_tick_padding">[docs]</a> def get_tick_padding(self):

"""Get the length of the tick outside of the axes."""

padding = {

'in': 0.0,

'inout': 0.5,

'out': 1.0

}

return self._size * padding[self._tickdir]</div>

def get_children(self):

children = [self.tick1line, self.tick2line,

self.gridline, self.label1, self.label2]

return children

def set_clip_path(self, clippath, transform=None):

# docstring inherited

martist.Artist.set_clip_path(self, clippath, transform)

self.gridline.set_clip_path(clippath, transform)

self.stale = True

<div class="viewcode-block" id="Tick.get_pad_pixels"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.get_pad_pixels.html#matplotlib.axis.Tick.get_pad_pixels">[docs]</a> def get_pad_pixels(self):

return self.figure.dpi * self._base_pad / 72</div>

def contains(self, mouseevent):

"""

Test whether the mouse event occurred in the Tick marks.

This function always returns false. It is more useful to test if the

axis as a whole contains the mouse rather than the set of tick marks.

"""

inside, info = self._default_contains(mouseevent)

if inside is not None:

return inside, info

return False, {}

<div class="viewcode-block" id="Tick.set_pad"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.set_pad.html#matplotlib.axis.Tick.set_pad">[docs]</a> def set_pad(self, val):

"""

Set the tick label pad in points

Parameters

----------

val : float

"""

self._apply_params(pad=val)

self.stale = True</div>

<div class="viewcode-block" id="Tick.get_pad"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.get_pad.html#matplotlib.axis.Tick.get_pad">[docs]</a> def get_pad(self):

"""Get the value of the tick label pad in points."""

return self._base_pad</div>

def _get_text1(self):

"""Get the default Text 1 instance."""

def _get_text2(self):

"""Get the default Text 2 instance."""

def _get_tick1line(self):

"""Get the default line2D instance for tick1."""

def _get_tick2line(self):

"""Get the default line2D instance for tick2."""

def _get_gridline(self):

"""Get the default grid Line2d instance for this tick."""

<div class="viewcode-block" id="Tick.get_loc"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.get_loc.html#matplotlib.axis.Tick.get_loc">[docs]</a> def get_loc(self):

"""Return the tick location (data coords) as a scalar."""

return self._loc</div>

@martist.allow_rasterization

def draw(self, renderer):

if not self.get_visible():

self.stale = False

return

renderer.open_group(self.__name__, gid=self.get_gid())

for artist in [self.gridline, self.tick1line, self.tick2line,

artist.draw(renderer)

renderer.close_group(self.__name__)

self.stale = False

<div class="viewcode-block" id="Tick.set_label1"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.set_label1.html#matplotlib.axis.Tick.set_label1">[docs]</a> def set_label1(self, s):

"""

Set the label1 text.

Parameters

----------

s : str

"""

self.label1.set_text(s)

self.stale = True</div>

set_label = set_label1

<div class="viewcode-block" id="Tick.set_label2"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.set_label2.html#matplotlib.axis.Tick.set_label2">[docs]</a> def set_label2(self, s):

"""

Set the label2 text.

Parameters

----------

s : str

"""

self.label2.set_text(s)

self.stale = True</div>

def set_url(self, url):

"""

Set the url of label1 and label2.

Parameters

----------

url : str

"""

super().set_url(url)

self.label1.set_url(url)

self.label2.set_url(url)

self.stale = True

def _set_artist_props(self, a):

a.set_figure(self.figure)

<div class="viewcode-block" id="Tick.get_view_interval"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.get_view_interval.html#matplotlib.axis.Tick.get_view_interval">[docs]</a> def get_view_interval(self):

"""

Return the view limits ``(min, max)`` of the axis the tick belongs to.

"""

raise NotImplementedError('Derived must override')</div>

def _apply_params(self, **kw):

for name, target in [("gridOn", self.gridline),

("tick1On", self.tick1line),

("tick2On", self.tick2line),

("label1On", self.label1),

("label2On", self.label2)]:

if name in kw:

target.set_visible(kw.pop(name))

if any(k in kw for k in ['size', 'width', 'pad', 'tickdir']):

self._size = kw.pop('size', self._size)

# Width could be handled outside this block, but it is

# convenient to leave it here.

self._width = kw.pop('width', self._width)

self._base_pad = kw.pop('pad', self._base_pad)

# apply_tickdir uses _size and _base_pad to make _pad,

# and also makes _tickmarkers.

self.apply_tickdir(kw.pop('tickdir', self._tickdir))

self.tick1line.set_marker(self._tickmarkers[0])

self.tick2line.set_marker(self._tickmarkers[1])

for line in (self.tick1line, self.tick2line):

line.set_markersize(self._size)

line.set_markeredgewidth(self._width)

# _get_text1_transform uses _pad from apply_tickdir.

trans = self._get_text1_transform()[0]

self.label1.set_transform(trans)

trans = self._get_text2_transform()[0]

self.label2.set_transform(trans)

tick_kw = {k: v for k, v in kw.items() if k in ['color', 'zorder']}

if 'color' in kw:

tick_kw['markeredgecolor'] = kw['color']

self.tick1line.set(**tick_kw)

self.tick2line.set(**tick_kw)

for k, v in tick_kw.items():

setattr(self, '_' + k, v)

if 'labelrotation' in kw:

self._set_labelrotation(kw.pop('labelrotation'))

self.label1.set(rotation=self._labelrotation[1])

self.label2.set(rotation=self._labelrotation[1])

label_kw = {k[5:]: v for k, v in kw.items()

if k in ['labelsize', 'labelcolor']}

for k, v in label_kw.items():

# for labelsize the text objects covert str ('small')

# -> points. grab the integer from the `Text` object

# instead of saving the string representation

v = getattr(self.label1, 'get_' + k)()

setattr(self, '_label' + k, v)

if k in _gridline_param_names}

self.gridline.set(**grid_kw)

for k, v in grid_kw.items():

setattr(self, '_grid_' + k, v)

<div class="viewcode-block" id="Tick.update_position"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Tick.update_position.html#matplotlib.axis.Tick.update_position">[docs]</a> def update_position(self, loc):

"""Set the location of tick in data coords with scalar *loc*."""

raise NotImplementedError('Derived must override')</div>

def _get_text1_transform(self):

raise NotImplementedError('Derived must override')

def _get_text2_transform(self):

raise NotImplementedError('Derived must override')</div>

<div class="viewcode-block" id="XTick"><a class="viewcode-back" href="../../api/axis_api.html#matplotlib.axis.XTick">[docs]</a>class XTick(Tick):

"""

Contains all the Artists needed to make an x tick - the tick line,

the label text and the grid line

"""

__name__ = 'xtick'

def __init__(self, *args, **kwargs):

super().__init__(*args, **kwargs)

# x in data coords, y in axes coords

self.tick1line.set(

xdata=[0], ydata=[0],

transform=self.axes.get_xaxis_transform(which="tick1"),

marker=self._tickmarkers[0],

)

self.tick2line.set(

)

self.gridline.set(

xdata=[0, 0], ydata=[0, 1],

)

# the y loc is 3 points below the min of y axis

trans, va, ha = self._get_text1_transform()

self.label1.set(

x=0, y=0,

verticalalignment=va, horizontalalignment=ha, transform=trans,

)

self.label2.set(

x=0, y=1,

)

def _get_text1_transform(self):

return self.axes.get_xaxis_text1_transform(self._pad)

def _get_text2_transform(self):

return self.axes.get_xaxis_text2_transform(self._pad)

def apply_tickdir(self, tickdir):

"""Set tick direction. Valid values are 'in', 'out', 'inout'."""

if tickdir is None:

tickdir = mpl.rcParams['%s.direction' % self.__name__.lower()]

cbook._check_in_list(['in', 'out', 'inout'], tickdir=tickdir)

self._tickdir = tickdir

if self._tickdir == 'in':

self._tickmarkers = (mlines.TICKUP, mlines.TICKDOWN)

elif self._tickdir == 'inout':

self._tickmarkers = ('|', '|')

else:

self._tickmarkers = (mlines.TICKDOWN, mlines.TICKUP)

self._pad = self._base_pad + self.get_tick_padding()

self.stale = True

def update_position(self, loc):

"""Set the location of tick in data coords with scalar *loc*."""

self.tick1line.set_xdata((loc,))

self.tick2line.set_xdata((loc,))

self.gridline.set_xdata((loc,))

self.label1.set_x(loc)

self.label2.set_x(loc)

self._loc = loc

self.stale = True

def get_view_interval(self):

# docstring inherited

return self.axes.viewLim.intervalx</div>

<div class="viewcode-block" id="YTick"><a class="viewcode-back" href="../../api/axis_api.html#matplotlib.axis.YTick">[docs]</a>class YTick(Tick):

"""

Contains all the Artists needed to make a Y tick - the tick line,

the label text and the grid line

"""

__name__ = 'ytick'

# x in axes coords, y in data coords

self.tick1line.set(

transform=self.axes.get_yaxis_transform(which="tick1"),

)

self.tick2line.set(

xdata=[1], ydata=[0],

transform=self.axes.get_yaxis_transform(which="tick2"),

)

self.gridline.set(

xdata=[0, 1], ydata=[0, 0],

transform=self.axes.get_yaxis_transform(which="grid"),

)

# the y loc is 3 points below the min of y axis

self.label1.set(

x=0, y=0,

)

self.label2.set(

x=1, y=0,

)

def _get_text1_transform(self):

return self.axes.get_yaxis_text1_transform(self._pad)

def _get_text2_transform(self):

return self.axes.get_yaxis_text2_transform(self._pad)

def apply_tickdir(self, tickdir):

if tickdir is None:

self._tickdir = tickdir

if self._tickdir == 'in':

self._tickmarkers = (mlines.TICKRIGHT, mlines.TICKLEFT)

elif self._tickdir == 'inout':

self._tickmarkers = ('_', '_')

else:

self._tickmarkers = (mlines.TICKLEFT, mlines.TICKRIGHT)

self.stale = True

def update_position(self, loc):

"""Set the location of tick in data coords with scalar *loc*."""

self.tick1line.set_ydata((loc,))

self.tick2line.set_ydata((loc,))

self.gridline.set_ydata((loc,))

self.label1.set_y(loc)

self.label2.set_y(loc)

self._loc = loc

self.stale = True

def get_view_interval(self):

# docstring inherited

<div class="viewcode-block" id="Ticker"><a class="viewcode-back" href="../../api/axis_api.html#matplotlib.axis.Ticker">[docs]</a>class Ticker:

"""

A container for the objects defining tick position and format.

Attributes

----------

locator : `matplotlib.ticker.Locator` subclass

Determines the positions of the ticks.

formatter : `matplotlib.ticker.Formatter` subclass

Determines the format of the tick labels.

"""

def __init__(self):

self._locator = None

self._formatter = None

@property

def locator(self):

return self._locator

@locator.setter

def locator(self, locator):

if not isinstance(locator, mticker.Locator):

cbook.warn_deprecated(

"3.2", message="Support for locators that do not subclass "

"matplotlib.ticker.Locator is deprecated since %(since)s and "

"support for them will be removed %(removal)s.")

self._locator = locator

@property

def formatter(self):

return self._formatter

@formatter.setter

def formatter(self, formatter):

if not isinstance(formatter, mticker.Formatter):

cbook.warn_deprecated(

"3.2", message="Support for formatters that do not subclass "

"matplotlib.ticker.Formatter is deprecated since %(since)s "

"and support for them will be removed %(removal)s.")

self._formatter = formatter</div>

class _LazyTickList:

"""

A descriptor for lazy instantiation of tick lists.

See comment above definition of the ``majorTicks`` and ``minorTicks``

attributes.

"""

def __init__(self, major):

self._major = major

def __get__(self, instance, cls):

if instance is None:

return self

else:

# instance._get_tick() can itself try to access the majorTicks

# attribute (e.g. in certain projection classes which override

# e.g. get_xaxis_text1_transform). In order to avoid infinite

# recursion, first set the majorTicks on the instance to an empty

# list, then create the tick and append it.

if self._major:

instance.majorTicks = []

tick = instance._get_tick(major=True)

instance.majorTicks.append(tick)

return instance.majorTicks

else:

instance.minorTicks = []

instance.minorTicks.append(tick)

return instance.minorTicks

<div class="viewcode-block" id="Axis"><a class="viewcode-back" href="../../api/axis_api.html#matplotlib.axis.Axis">[docs]</a>class Axis(martist.Artist):

"""

Base class for `.XAxis` and `.YAxis`.

Attributes

----------

isDefault_label : bool

axes : `matplotlib.axes.Axes`

The `~.axes.Axes` to which the Axis belongs.

major : `matplotlib.axis.Ticker`

Determines the major tick positions and their label format.

minor : `matplotlib.axis.Ticker`

Determines the minor tick positions and their label format.

callbacks : `matplotlib.cbook.CallbackRegistry`

label : `.Text`

The axis label.

labelpad : float

The distance between the axis label and the tick labels.

Defaults to :rc:`axes.labelpad` = 4.

offsetText : `.Text`

A `.Text` object containing the data offset of the ticks (if any).

pickradius : float

The acceptance radius for containment tests. See also `.Axis.contains`.

majorTicks : list of `.Tick`

The major ticks.

minorTicks : list of `.Tick`

The minor ticks.

"""

OFFSETTEXTPAD = 3

def __str__(self):

return "{}({},{})".format(

type(self).__name__, *self.axes.transAxes.transform((0, 0)))

def __init__(self, axes, pickradius=15):

"""

Parameters

----------

axes : `matplotlib.axes.Axes`

The `~.axes.Axes` to which the created Axis belongs.

pickradius : float

The acceptance radius for containment tests. See also

`.Axis.contains`.

"""

self._remove_overlapping_locs = True

self.isDefault_label = True

self.axes = axes

self.major = Ticker()

self.minor = Ticker()

self.callbacks = cbook.CallbackRegistry()

self._autolabelpos = True

self._smart_bounds = False # Deprecated in 3.2

self.label = mtext.Text(

np.nan, np.nan,

fontsize=mpl.rcParams['axes.labelsize'],

fontweight=mpl.rcParams['axes.labelweight'],

color=mpl.rcParams['axes.labelcolor'],

)

self._set_artist_props(self.label)

self.offsetText = mtext.Text(np.nan, np.nan)

self.labelpad = mpl.rcParams['axes.labelpad']

self.pickradius = pickradius

# Initialize here for testing; later add API

self._major_tick_kw = dict()

self._minor_tick_kw = dict()

self.cla()

self._set_scale('linear')

# During initialization, Axis objects often create ticks that are later

# unused; this turns out to be a very slow step. Instead, use a custom

# descriptor to make the tick lists lazy and instantiate them as needed.

majorTicks = _LazyTickList(major=True)

minorTicks = _LazyTickList(major=False)

<div class="viewcode-block" id="Axis.get_remove_overlapping_locs"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.get_remove_overlapping_locs.html#matplotlib.axis.Axis.get_remove_overlapping_locs">[docs]</a> def get_remove_overlapping_locs(self):

return self._remove_overlapping_locs</div>

<div class="viewcode-block" id="Axis.set_remove_overlapping_locs"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.set_remove_overlapping_locs.html#matplotlib.axis.Axis.set_remove_overlapping_locs">[docs]</a> def set_remove_overlapping_locs(self, val):

self._remove_overlapping_locs = bool(val)</div>

remove_overlapping_locs = property(

get_remove_overlapping_locs, set_remove_overlapping_locs,

doc=('If minor ticker locations that overlap with major '

'ticker locations should be trimmed.'))

<div class="viewcode-block" id="Axis.set_label_coords"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.set_label_coords.html#matplotlib.axis.Axis.set_label_coords">[docs]</a> def set_label_coords(self, x, y, transform=None):

"""

Set the coordinates of the label.

By default, the x coordinate of the y label and the y coordinate of the

x label are determined by the tick label bounding boxes, but this can

lead to poor alignment of multiple labels if there are multiple axes.

You can also specify the coordinate system of the label with the

transform. If None, the default coordinate system will be the axes

coordinate system: (0, 0) is bottom left, (0.5, 0.5) is center, etc.

"""

self._autolabelpos = False

if transform is None:

transform = self.axes.transAxes

self.label.set_transform(transform)

self.label.set_position((x, y))

self.stale = True</div>

def get_transform(self):

return self._scale.get_transform()

<div class="viewcode-block" id="Axis.get_scale"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.get_scale.html#matplotlib.axis.Axis.get_scale">[docs]</a> def get_scale(self):

"""Return this Axis' scale (as a str)."""

return self._scale.name</div>

def _set_scale(self, value, **kwargs):

self._scale = mscale.scale_factory(value, self, **kwargs)

self._scale.set_default_locators_and_formatters(self)

self.isDefault_majloc = True

self.isDefault_minloc = True

self.isDefault_majfmt = True

self.isDefault_minfmt = True

<div class="viewcode-block" id="Axis.limit_range_for_scale"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.limit_range_for_scale.html#matplotlib.axis.Axis.limit_range_for_scale">[docs]</a> def limit_range_for_scale(self, vmin, vmax):

return self._scale.limit_range_for_scale(vmin, vmax, self.get_minpos())</div>

def get_children(self):

return [self.label, self.offsetText,

*self.get_major_ticks(), *self.get_minor_ticks()]

<div class="viewcode-block" id="Axis.cla"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.cla.html#matplotlib.axis.Axis.cla">[docs]</a> def cla(self):

"""Clear this axis."""

self.label.set_text('') # self.set_label_text would change isDefault_

self._set_scale('linear')

# Clear the callback registry for this axis, or it may "leak"

# whether the grids are on

self._gridOnMajor = (

mpl.rcParams['axes.grid'] and

mpl.rcParams['axes.grid.which'] in ('both', 'major'))

self._gridOnMinor = (

mpl.rcParams['axes.grid'] and

self.reset_ticks()

self.converter = None

self.units = None

self.set_units(None)

self.stale = True</div>

<div class="viewcode-block" id="Axis.reset_ticks"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.reset_ticks.html#matplotlib.axis.Axis.reset_ticks">[docs]</a> def reset_ticks(self):

"""

Re-initialize the major and minor Tick lists.

Each list starts with a single fresh Tick.

"""

# Restore the lazy tick lists.

try:

del self.majorTicks

except AttributeError:

pass

try:

del self.minorTicks

except AttributeError:

pass

try:

self.set_clip_path(self.axes.patch)

except AttributeError:

pass</div>

<div class="viewcode-block" id="Axis.set_tick_params"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.axis.Axis.set_tick_params.html#matplotlib.axis.Axis.set_tick_params">[docs]</a> def set_tick_params(self, which='major', reset=False, **kw):

"""

Set appearance parameters for ticks, ticklabels, and gridlines.

For documentation of keyword arguments, see

:meth:`matplotlib.axes.Axes.tick_params`.

"""

cbook._check_in_list(['major', 'minor', 'both'], which=which)

kwtrans = self._translate_tick_kw(kw)

# the kwargs are stored in self._major/minor_tick_kw so that any

# future new ticks will automatically get them

if reset:

if which in ['major', 'both']:

self._major_tick_kw.clear()

self._major_tick_kw.update(kwtrans)

if which in ['minor', 'both']:

self._minor_tick_kw.clear()

self._minor_tick_kw.update(kwtrans)

self.reset_ticks()

else:

for tick in self.majorTicks:

tick._apply_params(**kwtrans)

for tick in self.minorTicks:

tick._apply_params(**kwtrans)

# labelOn and labelcolor also apply to the offset text.

if 'label1On' in kwtrans or 'label2On' in kwtrans:

self.offsetText.set_visible(

self._major_tick_kw.get('label1On', False)

or self._major_tick_kw.get('label2On', False))

if 'labelcolor' in kwtrans:

self.offsetText.set_color(kwtrans['labelcolor'])

self.stale = True</div>

@staticmethod

def _translate_tick_kw(kw):

# The following lists may be moved to a more accessible location.

kwkeys = ['size', 'width', 'color', 'tickdir', 'pad',

'labelsize', 'labelcolor', 'zorder', 'gridOn',

'tick1On', 'tick2On', 'label1On', 'label2On',

'length', 'direction', 'left', 'bottom', 'right', 'top',

'labelleft', 'labelbottom', 'labelright', 'labeltop',

'labelrotation'] + _gridline_param_names

kwtrans = {}

if 'length' in kw:

kwtrans['size'] = kw.pop('length')

if 'direction' in kw:

kwtrans['tickdir'] = kw.pop('direction')

if 'rotation' in kw:

kwtrans['labelrotation'] = kw.pop('rotation')

if 'left' in kw:

kwtrans['tick1On'] = kw.pop('left')

if 'bottom' in kw:

if 'right' in kw:

kwtrans['tick2On'] = kw.pop('right')

if 'top' in kw:

if 'labelleft' in kw:

kwtrans['label1On'] = kw.pop('labelleft')

if 'labelbottom' in kw:

if 'labelright' in kw:

kwtrans['label2On'] = kw.pop('labelright')

if 'labeltop' in kw:

if 'colors' in kw:

c = kw.pop('colors')

kwtrans['color'] = c

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

axis.html

Latest commit

History

axis.html

File metadata and controls