matplotlib/lib/matplotlib/artist.py at v3.11.2 · matplotlib/matplotlib · GitHub

History

1938 lines (1594 loc) · 64.2 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

from collections import namedtuple

import contextlib

from functools import cache, reduce, wraps

import inspect

from inspect import Signature, Parameter

import logging

from numbers import Number, Real

import operator

import re

import warnings

import numpy as np

import matplotlib as mpl

from . import _api, cbook

from .path import Path

from .transforms import (BboxBase, Bbox, IdentityTransform, Transform, TransformedBbox,

TransformedPatchPath, TransformedPath)

_log = logging.getLogger(__name__)

def _prevent_rasterization(draw):

# We assume that by default artists are not allowed to rasterize (unless

# its draw method is explicitly decorated). If it is being drawn after a

# rasterized artist and it has reached a raster_depth of 0, we stop

# rasterization so that it does not affect the behavior of normal artist

# (e.g., change in dpi).

@wraps(draw)

def draw_wrapper(artist, renderer, *args, **kwargs):

if renderer._raster_depth == 0 and renderer._rasterizing:

# Only stop when we are not in a rasterized parent

# and something has been rasterized since last stop.

renderer.stop_rasterizing()

renderer._rasterizing = False

return draw(artist, renderer, *args, **kwargs)

draw_wrapper._supports_rasterization = False

return draw_wrapper

def allow_rasterization(draw):

"""

Decorator for Artist.draw method. Provides routines

that run before and after the draw call. The before and after functions

are useful for changing artist-dependent renderer attributes or making

other setup function calls, such as starting and flushing a mixed-mode

renderer.

"""

@wraps(draw)

def draw_wrapper(artist, renderer):

try:

if artist.get_rasterized():

if renderer._raster_depth == 0 and not renderer._rasterizing:

renderer.start_rasterizing()

renderer._rasterizing = True

renderer._raster_depth += 1

else:

if renderer._raster_depth == 0 and renderer._rasterizing:

# Only stop when we are not in a rasterized parent

# and something has be rasterized since last stop

renderer.stop_rasterizing()

renderer._rasterizing = False

if artist.get_agg_filter() is not None:

renderer.start_filter()

return draw(artist, renderer)

finally:

if artist.get_agg_filter() is not None:

renderer.stop_filter(artist.get_agg_filter())

if artist.get_rasterized():

renderer._raster_depth -= 1

if (renderer._rasterizing and (fig := artist.get_figure(root=True)) and

fig.suppressComposite):

# restart rasterizing to prevent merging

renderer.stop_rasterizing()

renderer.start_rasterizing()

draw_wrapper._supports_rasterization = True

return draw_wrapper

def _finalize_rasterization(draw):

"""

Decorator for Artist.draw method. Needed on the outermost artist, i.e.

Figure, to finish up if the render is still in rasterized mode.

"""

@wraps(draw)

def draw_wrapper(artist, renderer, *args, **kwargs):

result = draw(artist, renderer, *args, **kwargs)

if renderer._rasterizing:

renderer.stop_rasterizing()

renderer._rasterizing = False

return result

return draw_wrapper

def _stale_axes_callback(self, val):

if self.axes:

self.axes.stale = val

_XYPair = namedtuple("_XYPair", "x y")

class Artist:

"""

Abstract base class for objects that render into a FigureCanvas.

Typically, all visible elements in a figure are subclasses of Artist.

"""

zorder = 0

def __init_subclass__(cls):

# Decorate draw() method so that all artists are able to stop

# rastrization when necessary. If the artist's draw method is already

# decorated (has a `_supports_rasterization` attribute), it won't be

# decorated.

if not hasattr(cls.draw, "_supports_rasterization"):

cls.draw = _prevent_rasterization(cls.draw)

# Inject custom set() methods into the subclass with signature and

# docstring based on the subclasses' properties.

if not hasattr(cls.set, '_autogenerated_signature'):

# Don't overwrite cls.set if the subclass or one of its parents

# has defined a set method set itself.

# If there was no explicit definition, cls.set is inherited from

# the hierarchy of auto-generated set methods, which hold the

# flag _autogenerated_signature.

return

cls.set = lambda self, **kwargs: Artist.set(self, **kwargs)

cls.set.__name__ = "set"

cls.set.__qualname__ = f"{cls.__qualname__}.set"

cls._update_set_signature_and_docstring()

_PROPERTIES_EXCLUDED_FROM_SET = [

'navigate_mode', # not a user-facing function

'figure', # changing the figure is such a profound operation

# that we don't want this in set()

'3d_properties', # cannot be used as a keyword due to leading digit

]

@classmethod

def _update_set_signature_and_docstring(cls):

"""

Update the signature of the set function to list all properties

as keyword arguments.

Property aliases are not listed in the signature for brevity, but

are still accepted as keyword arguments.

"""

cls.set.__signature__ = Signature(

[Parameter("self", Parameter.POSITIONAL_OR_KEYWORD),

*[Parameter(prop, Parameter.KEYWORD_ONLY, default=_api.UNSET)

for prop in ArtistInspector(cls).get_setters()

if prop not in Artist._PROPERTIES_EXCLUDED_FROM_SET]])

cls.set._autogenerated_signature = True

cls.set.__doc__ = ("""\

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to ::

a.set_a(A)

a.set_b(B)

a.set_c(C)

In addition to the full property names, aliases are also supported, e.g.

``set(lw=2)`` is equivalent to ``set(linewidth=2)``, but it is an error

to pass both simultaneously.

The order of the individual setter calls matches the order of parameters

in ``set()``. However, most properties do not depend on each other so

that order is rarely relevant.

Supported properties are

""" + kwdoc(cls))

def __init__(self):

self._stale = True

self.stale_callback = None

self._axes = None

self._parent_figure = None

self._transform = None

self._transformSet = False

self._visible = True

self._animated = False

self._alpha = None

self.clipbox = None

self._clippath = None

self._clipon = True

self._label = ''

self._picker = None

self._rasterized = False

self._agg_filter = None

# Normally, artist classes need to be queried for mouseover info if and

# only if they override get_cursor_data.

self._mouseover = type(self).get_cursor_data != Artist.get_cursor_data

self._callbacks = cbook.CallbackRegistry(signals=["pchanged"])

try:

self.axes = None

except AttributeError:

# Handle self.axes as a read-only property, as in Figure.

pass

self._remove_method = None

self._url = None

self._gid = None

self._snap = None

self._sketch = mpl.rcParams['path.sketch']

self._path_effects = mpl.rcParams['path.effects']

self._sticky_edges = None

self._in_layout = True

self._in_autoscale = False

def __getstate__(self):

d = self.__dict__.copy()

d['stale_callback'] = None

return d

def remove(self):

"""

Remove the artist from the figure if possible.

The effect will not be visible until the figure is redrawn, e.g.,

with `.FigureCanvasBase.draw_idle`. Call `~.axes.Axes.relim` to

update the Axes limits if desired.

Note: there is no support for removing the artist's legend entry.

"""

# There is no method to set the callback. Instead, the parent should

# set the _remove_method attribute directly. This would be a

# protected attribute if Python supported that sort of thing. The

# callback has one parameter, which is the child to be removed.

if self._remove_method is not None:

self._remove_method(self)

# clear stale callback

self.stale_callback = None

_ax_flag = False

ax = getattr(self, 'axes', None)

mouseover_set = getattr(ax, '_mouseover_set', None)

if mouseover_set is not None:

# remove from the mouse hit list

mouseover_set.discard(self)

ax.stale = True

self.axes = None # decouple the artist from the Axes

_ax_flag = True

if (fig := self.get_figure(root=False)) is not None:

if not _ax_flag:

fig.stale = True

self._parent_figure = None

else:

raise NotImplementedError('cannot remove artist')

def have_units(self):

"""Return whether units are set on any axis."""

ax = self.axes

return ax and any(axis.have_units() for axis in ax._axis_map.values())

def convert_xunits(self, x):

"""

Convert *x* using the unit type of the xaxis.

If the artist is not contained in an Axes or if the xaxis does not

have units, *x* itself is returned.

"""

ax = getattr(self, 'axes', None)

if ax is None or ax.xaxis is None:

return x

return ax.xaxis.convert_units(x)

def convert_yunits(self, y):

"""

Convert *y* using the unit type of the yaxis.

If the artist is not contained in an Axes or if the yaxis does not

have units, *y* itself is returned.

"""

ax = getattr(self, 'axes', None)

if ax is None or ax.yaxis is None:

return y

return ax.yaxis.convert_units(y)

@property

def axes(self):

"""The `~.axes.Axes` instance the artist resides in, or *None*."""

return self._axes

@axes.setter

def axes(self, new_axes):

if (new_axes is not None and self._axes is not None

and new_axes != self._axes):

raise ValueError("Can not reset the Axes. You are probably trying to reuse "

"an artist in more than one Axes which is not supported")

self._axes = new_axes

if new_axes is not None and new_axes is not self:

self.stale_callback = _stale_axes_callback

@property

def stale(self):

"""

Whether the artist is 'stale' and needs to be re-drawn for the output

to match the internal state of the artist.

"""

return self._stale

@stale.setter

def stale(self, val):

self._stale = val

# if the artist is animated it does not take normal part in the

# draw stack and is not expected to be drawn as part of the normal

# draw loop (when not saving) so do not propagate this change

if self._animated:

return

if val and self.stale_callback is not None:

self.stale_callback(self, val)

def get_window_extent(self, renderer=None):

"""

Get the artist's bounding box in display space, ignoring clipping.

The bounding box's width and height are non-negative.

Subclasses should override for inclusion in the bounding box "tight"

calculation. Default is to return an empty bounding box at 0, 0.

.. warning::

The extent can change due to any changes in the transform stack, such

as changing the Axes limits, the figure size, the canvas used (as is

done when saving a figure), or the DPI.

Relying on a once-retrieved window extent can lead to unexpected

behavior in various cases such as interactive figures being resized or

moved to a screen with different dpi, or figures that look fine on

screen render incorrectly when saved to file.

To get accurate results you may need to manually call

`~.Figure.savefig` or `~.Figure.draw_without_rendering` to have

Matplotlib compute the rendered size.

Parameters

----------

renderer : `~matplotlib.backend_bases.RendererBase`, optional

Renderer used to draw the figure (i.e. ``fig.canvas.get_renderer()``).

See Also

--------

.Artist.get_tightbbox :

Get the artist bounding box, taking clipping into account.

"""

return Bbox([[0, 0], [0, 0]])

def get_tightbbox(self, renderer=None):

"""

Get the artist's bounding box in display space, taking clipping into account.

Parameters

----------

renderer : `~matplotlib.backend_bases.RendererBase`, optional

Renderer used to draw the figure (i.e. ``fig.canvas.get_renderer()``).

Returns

-------

`.Bbox` or None

The enclosing bounding box (in figure pixel coordinates), or None

if clipping results in no intersection.

See Also

--------

.Artist.get_window_extent :

Get the artist bounding box, ignoring clipping.

"""

bbox = self.get_window_extent(renderer)

if self.get_clip_on():

clip_box = self.get_clip_box()

if clip_box is not None:

bbox = Bbox.intersection(bbox, clip_box)

clip_path = self.get_clip_path()

if clip_path is not None and bbox is not None:

clip_path = clip_path.get_fully_transformed_path()

bbox = Bbox.intersection(bbox, clip_path.get_extents())

return bbox

def add_callback(self, func):

"""

Add a callback function that will be called whenever one of the

`.Artist`'s properties changes.

Parameters

----------

func : callable

The callback function. It must have the signature::

def func(artist: Artist) -> Any

where *artist* is the calling `.Artist`. Return values may exist

but are ignored.

Returns

-------

int

The observer id associated with the callback. This id can be

used for removing the callback with `.remove_callback` later.

See Also

--------

remove_callback

"""

# Wrapping func in a lambda ensures it can be connected multiple times

# and never gets weakref-gc'ed.

return self._callbacks.connect("pchanged", lambda: func(self))

def remove_callback(self, oid):

"""

Remove a callback based on its observer id.

See Also

--------

add_callback

"""

self._callbacks.disconnect(oid)

def pchanged(self):

"""

Call all of the registered callbacks.

This function is triggered internally when a property is changed.

See Also

--------

add_callback

remove_callback

"""

self._callbacks.process("pchanged")

def is_transform_set(self):

"""

Return whether the Artist has an explicitly set transform.

This is *True* after `.set_transform` has been called.

"""

return self._transformSet

def set_transform(self, t):

"""

Set the artist transform.

Parameters

----------

t : `~matplotlib.transforms.Transform`

"""

self._transform = t

self._transformSet = True

self.pchanged()

self.stale = True

def get_transform(self):

"""Return the `.Transform` instance used by this artist."""

if self._transform is None:

self._transform = IdentityTransform()

elif (not isinstance(self._transform, Transform)

and hasattr(self._transform, '_as_mpl_transform')):

self._transform = self._transform._as_mpl_transform(self.axes)

return self._transform

def get_children(self):

r"""Return a list of the child `.Artist`\s of this `.Artist`."""

return []

def _different_canvas(self, event):

"""

Check whether an *event* occurred on a canvas other that this artist's canvas.

If this method returns True, the event definitely occurred on a different

canvas; if it returns False, either it occurred on the same canvas, or we may

not have enough information to know.

Subclasses should start their definition of `contains` as follows::

if self._different_canvas(mouseevent):

return False, {}

# subclass-specific implementation follows

"""

return (getattr(event, "canvas", None) is not None

and (fig := self.get_figure(root=True)) is not None

and event.canvas is not fig.canvas)

def contains(self, mouseevent):

"""

Test whether the artist contains the mouse event.

Parameters

----------

mouseevent : `~matplotlib.backend_bases.MouseEvent`

Returns

-------

contains : bool

Whether any values are within the radius.

details : dict

An artist-specific dictionary of details of the event context,

such as which points are contained in the pick radius. See the

individual Artist subclasses for details.

"""

_log.warning("%r needs 'contains' method", self.__class__.__name__)

return False, {}

def pickable(self):

"""

Return whether the artist is pickable.

See Also

--------

.Artist.set_picker, .Artist.get_picker, .Artist.pick

"""

return self.get_figure(root=False) is not None and self._picker is not None

def pick(self, mouseevent):

"""

Process a pick event.

Each child artist will fire a pick event if *mouseevent* is over

the artist and the artist has picker set.

See Also

--------

.Artist.set_picker, .Artist.get_picker, .Artist.pickable

"""

from .backend_bases import PickEvent # Circular import.

# Pick self

if self.pickable():

picker = self.get_picker()

if callable(picker):

inside, prop = picker(self, mouseevent)

else:

inside, prop = self.contains(mouseevent)

if inside:

PickEvent("pick_event", self.get_figure(root=True).canvas,

mouseevent, self, **prop)._process()

# Pick children

for a in self.get_children():

# make sure the event happened in the same Axes

ax = getattr(a, 'axes', None)

if (isinstance(a, mpl.figure.SubFigure)

or mouseevent.inaxes is None or ax is None

or mouseevent.inaxes == ax):

# we need to check if mouseevent.inaxes is None

# because some objects associated with an Axes (e.g., a

# tick label) can be outside the bounding box of the

# Axes and inaxes will be None

# also check that ax is None so that it traverse objects

# which do not have an axes property but children might

a.pick(mouseevent)

def set_picker(self, picker):

"""

Define the picking behavior of the artist.

Parameters

----------

picker : None or bool or float or callable

This can be one of the following:

- *None*: Picking is disabled for this artist (default).

- A boolean: If *True* then picking will be enabled and the

artist will fire a pick event if the mouse event is over

the artist.

- A float: If picker is a number it is interpreted as an

epsilon tolerance in points and the artist will fire

off an event if its data is within epsilon of the mouse

event. For some artists like lines and patch collections,

the artist may provide additional data to the pick event

that is generated, e.g., the indices of the data within

epsilon of the pick event

- A function: If picker is callable, it is a user supplied

function which determines whether the artist is hit by the

mouse event::

hit, props = picker(artist, mouseevent)

to determine the hit test. if the mouse event is over the

artist, return *hit=True* and props is a dictionary of

properties you want added to the PickEvent attributes.

"""

self._picker = picker

def get_picker(self):

"""

Return the picking behavior of the artist.

The possible values are described in `.Artist.set_picker`.

See Also

--------

.Artist.set_picker, .Artist.pickable, .Artist.pick

"""

return self._picker

def get_url(self):

"""Return the url."""

return self._url

def set_url(self, url):

"""

Set the url for the artist.

Parameters

----------

url : str

"""

self._url = url

def get_gid(self):

"""Return the group id."""

return self._gid

def set_gid(self, gid):

"""

Set the (group) id for the artist.

Parameters

----------

gid : str

"""

self._gid = gid

def get_snap(self):

"""

Return the snap setting.

See `.set_snap` for details.

"""

if mpl.rcParams['path.snap']:

return self._snap

else:

return False

def set_snap(self, snap):

"""

Set the snapping behavior.

Snapping aligns positions with the pixel grid, which results in

clearer images. For example, if a black line of 1px width was

defined at a position in between two pixels, the resulting image

would contain the interpolated value of that line in the pixel grid,

which would be a grey value on both adjacent pixel positions. In

contrast, snapping will move the line to the nearest integer pixel

value, so that the resulting image will really contain a 1px wide

black line.

Snapping is currently only supported by the Agg and MacOSX backends.

Parameters

----------

snap : bool or None

Possible values:

- *True*: Snap vertices to the nearest pixel center.

- *False*: Do not modify vertex positions.

- *None*: (auto) If the path contains only rectilinear line

segments, round to the nearest pixel center.

"""

self._snap = snap

self.stale = True

def get_sketch_params(self):

"""

Return the sketch parameters for the artist.

Returns

-------

tuple or None

A 3-tuple with the following elements:

- *scale*: The amplitude of the wiggle perpendicular to the

source line.

- *length*: The length of the wiggle along the line.

- *randomness*: The scale factor by which the length is

shrunken or expanded.

Returns *None* if no sketch parameters were set.

"""

return self._sketch

def set_sketch_params(self, scale=None, length=None, randomness=None):

"""

Set the sketch parameters.

Parameters

----------

scale : float, optional

The amplitude of the wiggle perpendicular to the source

line, in pixels. If scale is `None`, or not provided, no

sketch filter will be provided.

length : float, optional

The length of the wiggle along the line, in pixels

(default 128.0)

randomness : float, optional

The scale factor by which the length is shrunken or

expanded (default 16.0)

The PGF backend uses this argument as an RNG seed and not as

described above. Using the same seed yields the same random shape.

.. ACCEPTS: (scale: float, length: float, randomness: float)

"""

if scale is None:

self._sketch = None

else:

self._sketch = (scale, length or 128.0, randomness or 16.0)

self.stale = True

def set_path_effects(self, path_effects):

"""

Set the path effects.

Parameters

----------

path_effects : list of `.AbstractPathEffect`

"""

self._path_effects = path_effects

self.stale = True

def get_path_effects(self):

return self._path_effects

def get_figure(self, root=False):

"""

Return the `.Figure` or `.SubFigure` instance the artist belongs to.

Parameters

----------

root : bool, default=False

If False, return the (Sub)Figure this artist is on. If True,

return the root Figure for a nested tree of SubFigures.

"""

if root and self._parent_figure is not None:

return self._parent_figure.get_figure(root=True)

return self._parent_figure

def set_figure(self, fig):

"""

Set the `.Figure` or `.SubFigure` instance the artist belongs to.

.. warning::

This function should typically not be called by users.

This is a low-level API and only modifies the internal state of the

Artist. Only modifying this is not enough and will typically lead

to an inconsistent state, because the state of the figure has to

be changed as well.

Users should typically instead call one of the high-level APIs, i.e.

`.Figure.add_artist` or one of the Axes methods

:ref:`axes-api-adding-artists`.

Parameters

----------

fig : `~matplotlib.figure.Figure` or `~matplotlib.figure.SubFigure`

"""

# if this is a no-op just return

if self._parent_figure is fig:

return

# if we currently have a figure (the case of both `self.figure`

# and *fig* being none is taken care of above) we then user is

# trying to change the figure an artist is associated with which

# is not allowed for the same reason as adding the same instance

# to more than one Axes

if self._parent_figure is not None:

raise RuntimeError("Can not put single artist in "

"more than one figure")

self._parent_figure = fig

if self._parent_figure and self._parent_figure is not self:

self.pchanged()

self.stale = True

figure = property(get_figure, set_figure,

doc=("The (Sub)Figure that the artist is on. For more "

"control, use the `get_figure` method."))

def set_clip_box(self, clipbox):

"""

Set the artist's clip `.Bbox`.

Parameters

----------

clipbox : `~matplotlib.transforms.BboxBase` or None

Will typically be created from a `.TransformedBbox`. For instance,

``TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)`` is the default

clipping for an artist added to an Axes.

"""

_api.check_isinstance((BboxBase, None), clipbox=clipbox)

if clipbox != self.clipbox:

self.clipbox = clipbox

self.pchanged()

self.stale = True

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

"""

Set the artist's clip path.

Parameters

----------

path : `~matplotlib.patches.Patch` or `.Path` or `.TransformedPath` or None

The clip path. If given a `.Path`, *transform* must be provided as

well. If *None*, a previously set clip path is removed.

transform : `~matplotlib.transforms.Transform`, optional

Only used if *path* is a `.Path`, in which case the given `.Path`

is converted to a `.TransformedPath` using *transform*.

Notes

-----

For efficiency, if *path* is a `.Rectangle` this method will set the

clipping box to the corresponding rectangle and set the clipping path

to ``None``.

For technical reasons (support of `~.Artist.set`), a tuple

(*path*, *transform*) is also accepted as a single positional

parameter.

.. ACCEPTS: Patch or (Path, Transform) or None

"""

from matplotlib.patches import Patch, Rectangle

success = False

if transform is None:

if isinstance(path, Rectangle):

self.clipbox = TransformedBbox(Bbox.unit(),

path.get_transform())

self._clippath = None

success = True

elif isinstance(path, Patch):

self._clippath = TransformedPatchPath(path)

success = True

elif isinstance(path, tuple):

path, transform = path

if path is None:

self._clippath = None

success = True

elif isinstance(path, Path):

self._clippath = TransformedPath(path, transform)

success = True

elif isinstance(path, TransformedPatchPath):

self._clippath = path

success = True

elif isinstance(path, TransformedPath):

self._clippath = path

success = True

if not success:

raise TypeError(

"Invalid arguments to set_clip_path, of type "

f"{type(path).__name__} and {type(transform).__name__}")

# This may result in the callbacks being hit twice, but guarantees they

# will be hit at least once.

self.pchanged()

self.stale = True

def get_alpha(self):

"""

Return the alpha value used for blending - not supported on all

backends.

"""

return self._alpha

def get_visible(self):

"""Return the visibility."""

return self._visible

def get_animated(self):

"""Return whether the artist is animated."""

return self._animated

def get_in_layout(self):

"""

Return boolean flag, ``True`` if artist is included in layout

calculations.

E.g. :ref:`constrainedlayout_guide`,

`.Figure.tight_layout()`, and

``fig.savefig(fname, bbox_inches='tight')``.

"""

return self._in_layout

def _get_in_autoscale(self):

"""

Return whether the artist is included in autoscaling calculations.

E.g. `.axes.Axes.autoscale_view()`.

"""

return self._in_autoscale

def _fully_clipped_to_axes(self):

"""

Return a boolean flag, ``True`` if the artist is clipped to the Axes

and can thus be skipped in layout calculations. Requires `get_clip_on`

is True, one of `clip_box` or `clip_path` is set, ``clip_box.extents``

is equivalent to ``ax.bbox.extents`` (if set), and ``clip_path._patch``

is equivalent to ``ax.patch`` (if set).

"""

# Note that ``clip_path.get_fully_transformed_path().get_extents()``

# cannot be directly compared to ``axes.bbox.extents`` because the

# extents may be undefined (i.e. equivalent to ``Bbox.null()``)

# before the associated artist is drawn, and this method is meant

# to determine whether ``axes.get_tightbbox()`` may bypass drawing

clip_box = self.get_clip_box()

clip_path = self.get_clip_path()

return (self.axes is not None

and self.get_clip_on()

and (clip_box is not None or clip_path is not None)

and (clip_box is None

or np.all(clip_box.extents == self.axes.bbox.extents))

and (clip_path is None

or isinstance(clip_path, TransformedPatchPath)

and clip_path._patch is self.axes.patch))

def get_clip_on(self):

"""Return whether the artist uses clipping."""

return self._clipon

def get_clip_box(self):

"""Return the clipbox."""

return self.clipbox

def get_clip_path(self):

"""Return the clip path."""

return self._clippath

def get_transformed_clip_path_and_affine(self):

"""

Return the clip path with the non-affine part of its

transformation applied, and the remaining affine part of its

transformation.

"""

if self._clippath is not None:

return self._clippath.get_transformed_path_and_affine()

return None, None

def set_clip_on(self, b):

"""

Set whether the artist uses clipping.

When False, artists will be visible outside the Axes which

can lead to unexpected results.

Parameters

----------

b : bool

"""

self._clipon = b

# This may result in the callbacks being hit twice, but ensures they

# are hit at least once

self.pchanged()

self.stale = True

def _set_gc_clip(self, gc):

"""Set the clip properly for the gc."""

if self._clipon:

if self.clipbox is not None:

gc.set_clip_rectangle(self.clipbox)

gc.set_clip_path(self._clippath)

else:

gc.set_clip_rectangle(None)

gc.set_clip_path(None)

def get_rasterized(self):

"""Return whether the artist is to be rasterized."""

return self._rasterized

def set_rasterized(self, rasterized):

"""

View remainder of file in raw view

matplotlib/lib/matplotlib/artist.py at v3.11.2 · matplotlib/matplotlib · GitHub

Uh oh!

Expand file tree

Breadcrumbs

artist.py

Latest commit

History

Breadcrumbs

artist.py

File metadata and controls