matplotlib.github.com/3.3.4/_modules/matplotlib/legend.html at main · matplotlib/matplotlib.github.com

History

1350 lines (1117 loc) · 159 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.legend — Matplotlib 3.3.4 documentation</title>

title="Search within Matplotlib 3.3.4 documentation"

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

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.4). 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.4</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>

<li class="nav-item nav-item-this"><a href="">matplotlib.legend</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.legend</h1><div class="highlight"><pre>

"""

The legend module defines the Legend class, which is responsible for

drawing legends associated with axes and/or figures.

.. important::

It is unlikely that you would ever create a Legend instance manually.

Most users would normally create a legend via the `~.Axes.legend`

function. For more details on legends there is also a :doc:`legend guide

</tutorials/intermediate/legend_guide>`.

The `Legend` class is a container of legend handles and legend texts.

The legend handler map specifies how to create legend handles from artists

(lines, patches, etc.) in the axes or figures. Default legend handlers are

defined in the :mod:`~matplotlib.legend_handler` module. While not all artist

types are covered by the default legend handlers, custom legend handlers can be

defined to support arbitrary objects.

See the :doc:`legend guide </tutorials/intermediate/legend_guide>` for more

information.

"""

import itertools

import logging

import time

import numpy as np

import matplotlib as mpl

from matplotlib import cbook, docstring, colors

from matplotlib.artist import Artist, allow_rasterization

from matplotlib.cbook import silent_list

from matplotlib.font_manager import FontProperties

from matplotlib.lines import Line2D

from matplotlib.patches import Patch, Rectangle, Shadow, FancyBboxPatch

from matplotlib.collections import (LineCollection, RegularPolyCollection,

CircleCollection, PathCollection,

PolyCollection)

from matplotlib.transforms import Bbox, BboxBase, TransformedBbox

from matplotlib.transforms import BboxTransformTo, BboxTransformFrom

from matplotlib.offsetbox import HPacker, VPacker, TextArea, DrawingArea

from matplotlib.offsetbox import DraggableOffsetBox

from matplotlib.container import ErrorbarContainer, BarContainer, StemContainer

from . import legend_handler

<div class="viewcode-block" id="DraggableLegend"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.DraggableLegend">[docs]</a>class DraggableLegend(DraggableOffsetBox):

def __init__(self, legend, use_blit=False, update="loc"):

"""

Wrapper around a `.Legend` to support mouse dragging.

Parameters

----------

legend : `.Legend`

The `.Legend` instance to wrap.

use_blit : bool, optional

Use blitting for faster image composition. For details see

:ref:`func-animation`.

update : {'loc', 'bbox'}, optional

If "loc", update the *loc* parameter of the legend upon finalizing.

If "bbox", update the *bbox_to_anchor* parameter.

"""

self.legend = legend

cbook._check_in_list(["loc", "bbox"], update=update)

self._update = update

DraggableOffsetBox.__init__(self, legend, legend._legend_box,

use_blit=use_blit)

<div class="viewcode-block" id="DraggableLegend.finalize_offset"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.DraggableLegend.finalize_offset">[docs]</a> def finalize_offset(self):

if self._update == "loc":

self._update_loc(self.get_loc_in_canvas())

elif self._update == "bbox":

self._bbox_to_anchor(self.get_loc_in_canvas())</div>

def _update_loc(self, loc_in_canvas):

bbox = self.legend.get_bbox_to_anchor()

# if bbox has zero width or height, the transformation is

# ill-defined. Fall back to the default bbox_to_anchor.

if bbox.width == 0 or bbox.height == 0:

self.legend.set_bbox_to_anchor(None)

_bbox_transform = BboxTransformFrom(bbox)

self.legend._loc = tuple(_bbox_transform.transform(loc_in_canvas))

def _update_bbox_to_anchor(self, loc_in_canvas):

loc_in_bbox = self.legend.axes.transAxes.transform(loc_in_canvas)

docstring.interpd.update(_legend_kw_doc="""

loc : str or pair of floats, default: :rc:`legend.loc` ('best' for axes, \

'upper right' for figures)

The location of the legend.

The strings

``'upper left', 'upper right', 'lower left', 'lower right'``

place the legend at the corresponding corner of the axes/figure.

The strings

``'upper center', 'lower center', 'center left', 'center right'``

place the legend at the center of the corresponding edge of the

axes/figure.

The string ``'center'`` places the legend at the center of the axes/figure.

The string ``'best'`` places the legend at the location, among the nine

locations defined so far, with the minimum overlap with other drawn

artists. This option can be quite slow for plots with large amounts of

data; your plotting speed may benefit from providing a specific location.

The location can also be a 2-tuple giving the coordinates of the lower-left

corner of the legend in axes coordinates (in which case *bbox_to_anchor*

will be ignored).

For back-compatibility, ``'center right'`` (but no other location) can also

be spelled ``'right'``, and each "string" locations can also be given as a

numeric value:

=============== =============

Location String Location Code

=============== =============

'best' 0

'upper right' 1

'upper left' 2

'lower left' 3

'lower right' 4

'right' 5

'center left' 6

'center right' 7

'lower center' 8

'upper center' 9

'center' 10

=============== =============

bbox_to_anchor : `.BboxBase`, 2-tuple, or 4-tuple of floats

Box that is used to position the legend in conjunction with *loc*.

Defaults to `axes.bbox` (if called as a method to `.Axes.legend`) or

`figure.bbox` (if `.Figure.legend`). This argument allows arbitrary

placement of the legend.

Bbox coordinates are interpreted in the coordinate system given by

*bbox_transform*, with the default transform

Axes or Figure coordinates, depending on which ``legend`` is called.

If a 4-tuple or `.BboxBase` is given, then it specifies the bbox

``(x, y, width, height)`` that the legend is placed in.

To put the legend in the best location in the bottom right

quadrant of the axes (or figure)::

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

A 2-tuple ``(x, y)`` places the corner of the legend specified by *loc* at

x, y. For example, to put the legend's upper right-hand corner in the

center of the axes (or figure) the following keywords can be used::

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncol : int, default: 1

The number of columns that the legend has.

prop : None or `matplotlib.font_manager.FontProperties` or dict

The font properties of the legend. If None (default), the current

:data:`matplotlib.rcParams` will be used.

fontsize : int or {'xx-small', 'x-small', 'small', 'medium', 'large', \

'x-large', 'xx-large'}

The font size of the legend. If the value is numeric the size will be the

absolute font size in points. String values are relative to the current

default font size. This argument is only used if *prop* is not specified.

labelcolor : str or list

Sets the color of the text in the legend. Can be a valid color string

(for example, 'red'), or a list of color strings. The labelcolor can

also be made to match the color of the line or marker using 'linecolor',

'markerfacecolor' (or 'mfc'), or 'markeredgecolor' (or 'mec').

numpoints : int, default: :rc:`legend.numpoints`

The number of marker points in the legend when creating a legend

entry for a `.Line2D` (line).

scatterpoints : int, default: :rc:`legend.scatterpoints`

The number of marker points in the legend when creating

a legend entry for a `.PathCollection` (scatter plot).

scatteryoffsets : iterable of floats, default: ``[0.375, 0.5, 0.3125]``

The vertical offset (relative to the font size) for the markers

created for a scatter plot legend entry. 0.0 is at the base the

legend text, and 1.0 is at the top. To draw all markers at the

same height, set to ``[0.5]``.

markerscale : float, default: :rc:`legend.markerscale`

The relative size of legend markers compared with the originally

drawn ones.

markerfirst : bool, default: True

If *True*, legend marker is placed to the left of the legend label.

If *False*, legend marker is placed to the right of the legend label.

frameon : bool, default: :rc:`legend.frameon`

Whether the legend should be drawn on a patch (frame).

fancybox : bool, default: :rc:`legend.fancybox`

Whether round edges should be enabled around the `~.FancyBboxPatch` which

makes up the legend's background.

shadow : bool, default: :rc:`legend.shadow`

Whether to draw a shadow behind the legend.

framealpha : float, default: :rc:`legend.framealpha`

The alpha transparency of the legend's background.

If *shadow* is activated and *framealpha* is ``None``, the default value is

ignored.

facecolor : "inherit" or color, default: :rc:`legend.facecolor`

The legend's background color.

If ``"inherit"``, use :rc:`axes.facecolor`.

edgecolor : "inherit" or color, default: :rc:`legend.edgecolor`

The legend's background patch edge color.

If ``"inherit"``, use take :rc:`axes.edgecolor`.

mode : {"expand", None}

If *mode* is set to ``"expand"`` the legend will be horizontally

expanded to fill the axes area (or *bbox_to_anchor* if defines

the legend's size).

bbox_transform : None or `matplotlib.transforms.Transform`

The transform for the bounding box (*bbox_to_anchor*). For a value

of ``None`` (default) the Axes'

:data:`~matplotlib.axes.Axes.transAxes` transform will be used.

title : str or None

The legend's title. Default is no title (``None``).

title_fontsize : int or {'xx-small', 'x-small', 'small', 'medium', 'large', \

'x-large', 'xx-large'}, default: :rc:`legend.title_fontsize`

The font size of the legend's title.

borderpad : float, default: :rc:`legend.borderpad`

The fractional whitespace inside the legend border, in font-size units.

labelspacing : float, default: :rc:`legend.labelspacing`

The vertical space between the legend entries, in font-size units.

handlelength : float, default: :rc:`legend.handlelength`

The length of the legend handles, in font-size units.

handletextpad : float, default: :rc:`legend.handletextpad`

The pad between the legend handle and text, in font-size units.

borderaxespad : float, default: :rc:`legend.borderaxespad`

The pad between the axes and legend border, in font-size units.

columnspacing : float, default: :rc:`legend.columnspacing`

The spacing between columns, in font-size units.

handler_map : dict or None

The custom dictionary mapping instances or types to a legend

handler. This *handler_map* updates the default handler map

found at `matplotlib.legend.Legend.get_legend_handler_map`.

""")

<div class="viewcode-block" id="Legend"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend">[docs]</a>class Legend(Artist):

"""

Place a legend on the axes at location loc.

"""

codes = {'best': 0, # only implemented for axes legends

'upper right': 1,

'upper left': 2,

'lower left': 3,

'lower right': 4,

'right': 5,

'center left': 6,

'center right': 7,

'lower center': 8,

'upper center': 9,

'center': 10,

}

zorder = 5

def __str__(self):

return "Legend"

@docstring.dedent_interpd

def __init__(self, parent, handles, labels,

loc=None,

numpoints=None, # the number of points in the legend line

markerscale=None, # the relative size of legend markers

# vs. original

markerfirst=True, # controls ordering (left-to-right) of

# legend marker and label

scatterpoints=None, # number of scatter points

scatteryoffsets=None,

prop=None, # properties for the legend texts

fontsize=None, # keyword to set font size directly

labelcolor=None, # keyword to set the text color

# spacing & pad defined as a fraction of the font-size

borderpad=None, # the whitespace inside the legend border

labelspacing=None, # the vertical space between the legend

# entries

handlelength=None, # the length of the legend handles

handleheight=None, # the height of the legend handles

handletextpad=None, # the pad between the legend handle

# and text

borderaxespad=None, # the pad between the axes and legend

# border

columnspacing=None, # spacing between columns

ncol=1, # number of columns

mode=None, # mode for horizontal distribution of columns.

# None, "expand"

fancybox=None, # True use a fancy box, false use a rounded

# box, none use rc

shadow=None,

title=None, # set a title for the legend

title_fontsize=None, # the font size for the title

framealpha=None, # set frame alpha

edgecolor=None, # frame patch edgecolor

facecolor=None, # frame patch facecolor

bbox_to_anchor=None, # bbox that the legend will be anchored.

bbox_transform=None, # transform for the bbox

frameon=None, # draw frame

handler_map=None,

):

"""

Parameters

----------

parent : `~matplotlib.axes.Axes` or `.Figure`

The artist that contains the legend.

handles : list of `.Artist`

A list of Artists (lines, patches) to be added to the legend.

labels : list of str

A list of labels to show next to the artists. The length of handles

and labels should be the same. If they are not, they are truncated

to the smaller of both lengths.

Other Parameters

----------------

%(_legend_kw_doc)s

Notes

-----

Users can specify any arbitrary location for the legend using the

*bbox_to_anchor* keyword argument. *bbox_to_anchor* can be a

`.BboxBase` (or derived therefrom) or a tuple of 2 or 4 floats.

See `set_bbox_to_anchor` for more detail.

The legend location can be specified by setting *loc* with a tuple of

2 floats, which is interpreted as the lower-left corner of the legend

in the normalized axes coordinate.

"""

# local import only to avoid circularity

from matplotlib.axes import Axes

from matplotlib.figure import Figure

Artist.__init__(self)

if prop is None:

if fontsize is not None:

self.prop = FontProperties(size=fontsize)

else:

self.prop = FontProperties(

size=mpl.rcParams["legend.fontsize"])

else:

self.prop = FontProperties._from_any(prop)

if isinstance(prop, dict) and "size" not in prop:

self.prop.set_size(mpl.rcParams["legend.fontsize"])

self._fontsize = self.prop.get_size_in_points()

self.texts = []

self.legendHandles = []

self._legend_title_box = None

#: A dictionary with the extra handler mappings for this Legend

#: instance.

self._custom_handler_map = handler_map

locals_view = locals()

for name in ["numpoints", "markerscale", "shadow", "columnspacing",

"scatterpoints", "handleheight", 'borderpad',

'labelspacing', 'handlelength', 'handletextpad',

'borderaxespad']:

if locals_view[name] is None:

value = mpl.rcParams["legend." + name]

else:

value = locals_view[name]

setattr(self, name, value)

del locals_view

# trim handles and labels if illegal label...

_lab, _hand = [], []

for label, handle in zip(labels, handles):

if isinstance(label, str) and label.startswith('_'):

cbook._warn_external('The handle {!r} has a label of {!r} '

'which cannot be automatically added to'

' the legend.'.format(handle, label))

else:

_lab.append(label)

_hand.append(handle)

labels, handles = _lab, _hand

handles = list(handles)

if len(handles) < 2:

ncol = 1

self._ncol = ncol

if self.numpoints <= 0:

raise ValueError("numpoints must be > 0; it was %d" % numpoints)

# introduce y-offset for handles of the scatter plot

if scatteryoffsets is None:

self._scatteryoffsets = np.array([3. / 8., 4. / 8., 2.5 / 8.])

else:

reps = self.scatterpoints // len(self._scatteryoffsets) + 1

reps)[:self.scatterpoints]

# _legend_box is a VPacker instance that contains all

# legend items and will be initialized from _init_legend_box()

# method.

self._legend_box = None

if isinstance(parent, Axes):

self.isaxes = True

self.axes = parent

self.set_figure(parent.figure)

elif isinstance(parent, Figure):

self.isaxes = False

self.set_figure(parent)

else:

raise TypeError("Legend needs either Axes or Figure as parent")

self.parent = parent

self._loc_used_default = loc is None

if loc is None:

loc = mpl.rcParams["legend.loc"]

if not self.isaxes and loc in [0, 'best']:

loc = 'upper right'

if isinstance(loc, str):

if loc not in self.codes:

raise ValueError(

"Unrecognized location {!r}. Valid locations are\n\t{}\n"

.format(loc, '\n\t'.join(self.codes)))

else:

loc = self.codes[loc]

if not self.isaxes and loc == 0:

raise ValueError(

"Automatic legend placement (loc='best') not implemented for "

"figure legend.")

self._mode = mode

self.set_bbox_to_anchor(bbox_to_anchor, bbox_transform)

# We use FancyBboxPatch to draw a legend frame. The location

# and size of the box will be updated during the drawing time.

if facecolor is None:

facecolor = mpl.rcParams["legend.facecolor"]

if facecolor == 'inherit':

if edgecolor is None:

edgecolor = mpl.rcParams["legend.edgecolor"]

if edgecolor == 'inherit':

if fancybox is None:

fancybox = mpl.rcParams["legend.fancybox"]

self.legendPatch = FancyBboxPatch(

xy=(0, 0), width=1, height=1,

facecolor=facecolor, edgecolor=edgecolor,

# If shadow is used, default to alpha=1 (#8943).

alpha=(framealpha if framealpha is not None

else 1 if shadow

else mpl.rcParams["legend.framealpha"]),

# The width and height of the legendPatch will be set (in draw())

# to the length that includes the padding. Thus we set pad=0 here.

boxstyle=("round,pad=0,rounding_size=0.2" if fancybox

else "square,pad=0"),

mutation_scale=self._fontsize,

snap=True,

visible=(frameon if frameon is not None

else mpl.rcParams["legend.frameon"])

)

self._set_artist_props(self.legendPatch)

# init with null renderer

self._init_legend_box(handles, labels, markerfirst)

tmp = self._loc_used_default

self._set_loc(loc)

self._loc_used_default = tmp # ignore changes done by _set_loc

# figure out title fontsize:

if title_fontsize is None:

title_fontsize = mpl.rcParams['legend.title_fontsize']

tprop = FontProperties(size=title_fontsize)

self.set_title(title, prop=tprop)

self._draggable = None

# set the text color

color_getters = { # getter function depends on line or patch

'linecolor': ['get_color', 'get_facecolor'],

'markerfacecolor': ['get_markerfacecolor', 'get_facecolor'],

'mfc': ['get_markerfacecolor', 'get_facecolor'],

'markeredgecolor': ['get_markeredgecolor', 'get_edgecolor'],

'mec': ['get_markeredgecolor', 'get_edgecolor'],

}

if labelcolor is None:

pass

elif isinstance(labelcolor, str) and labelcolor in color_getters:

getter_names = color_getters[labelcolor]

for handle, text in zip(self.legendHandles, self.texts):

for getter_name in getter_names:

try:

color = getattr(handle, getter_name)()

text.set_color(color)

break

except AttributeError:

pass

elif np.iterable(labelcolor):

for text, color in zip(self.texts,

itertools.cycle(

colors.to_rgba_array(labelcolor))):

text.set_color(color)

else:

raise ValueError("Invalid argument for labelcolor : %s" %

str(labelcolor))

def _set_artist_props(self, a):

"""

Set the boilerplate props for artists added to axes.

"""

a.set_figure(self.figure)

if self.isaxes:

# a.set_axes(self.axes)

a.axes = self.axes

a.set_transform(self.get_transform())

def _set_loc(self, loc):

# find_offset function will be provided to _legend_box and

# _legend_box will draw itself at the location of the return

# value of the find_offset.

self._loc_used_default = False

self._loc_real = loc

self.stale = True

self._legend_box.set_offset(self._findoffset)

def _get_loc(self):

return self._loc_real

_loc = property(_get_loc, _set_loc)

def _findoffset(self, width, height, xdescent, ydescent, renderer):

"""Helper function to locate the legend."""

if self._loc == 0: # "best".

x, y = self._find_best_position(width, height, renderer)

elif self._loc in Legend.codes.values(): # Fixed location.

bbox = Bbox.from_bounds(0, 0, width, height)

x, y = self._get_anchored_bbox(self._loc, bbox,

self.get_bbox_to_anchor(),

renderer)

else: # Axes or figure coordinates.

fx, fy = self._loc

bbox = self.get_bbox_to_anchor()

x, y = bbox.x0 + bbox.width * fx, bbox.y0 + bbox.height * fy

return x + xdescent, y + ydescent

<div class="viewcode-block" id="Legend.draw"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.draw">[docs]</a> @allow_rasterization

def draw(self, renderer):

# docstring inherited

if not self.get_visible():

return

renderer.open_group('legend', gid=self.get_gid())

fontsize = renderer.points_to_pixels(self._fontsize)

# if mode == fill, set the width of the legend_box to the

# width of the parent (minus pads)

if self._mode in ["expand"]:

pad = 2 * (self.borderaxespad + self.borderpad) * fontsize

self._legend_box.set_width(self.get_bbox_to_anchor().width - pad)

# update the location and size of the legend. This needs to

# be done in any case to clip the figure right.

bbox = self._legend_box.get_window_extent(renderer)

self.legendPatch.set_bounds(bbox.x0, bbox.y0, bbox.width, bbox.height)

self.legendPatch.set_mutation_scale(fontsize)

if self.shadow:

Shadow(self.legendPatch, 2, -2).draw(renderer)

self.legendPatch.draw(renderer)

self._legend_box.draw(renderer)

renderer.close_group('legend')

self.stale = False</div>

# _default_handler_map defines the default mapping between plot

# elements and the legend handlers.

_default_handler_map = {

StemContainer: legend_handler.HandlerStem(),

ErrorbarContainer: legend_handler.HandlerErrorbar(),

Line2D: legend_handler.HandlerLine2D(),

Patch: legend_handler.HandlerPatch(),

LineCollection: legend_handler.HandlerLineCollection(),

RegularPolyCollection: legend_handler.HandlerRegularPolyCollection(),

CircleCollection: legend_handler.HandlerCircleCollection(),

BarContainer: legend_handler.HandlerPatch(

update_func=legend_handler.update_from_first_child),

tuple: legend_handler.HandlerTuple(),

PathCollection: legend_handler.HandlerPathCollection(),

PolyCollection: legend_handler.HandlerPolyCollection()

}

# (get|set|update)_default_handler_maps are public interfaces to

# modify the default handler map.

<div class="viewcode-block" id="Legend.get_default_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_default_handler_map">[docs]</a> @classmethod

def get_default_handler_map(cls):

"""

A class method that returns the default handler map.

"""

return cls._default_handler_map</div>

<div class="viewcode-block" id="Legend.set_default_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.set_default_handler_map">[docs]</a> @classmethod

def set_default_handler_map(cls, handler_map):

"""

A class method to set the default handler map.

"""

cls._default_handler_map = handler_map</div>

<div class="viewcode-block" id="Legend.update_default_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.update_default_handler_map">[docs]</a> @classmethod

def update_default_handler_map(cls, handler_map):

"""

A class method to update the default handler map.

"""

cls._default_handler_map.update(handler_map)</div>

<div class="viewcode-block" id="Legend.get_legend_handler_map"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_legend_handler_map">[docs]</a> def get_legend_handler_map(self):

"""

Return the handler map.

"""

default_handler_map = self.get_default_handler_map()

if self._custom_handler_map:

hm = default_handler_map.copy()

hm.update(self._custom_handler_map)

return hm

else:

return default_handler_map</div>

<div class="viewcode-block" id="Legend.get_legend_handler"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_legend_handler">[docs]</a> @staticmethod

def get_legend_handler(legend_handler_map, orig_handle):

"""

Return a legend handler from *legend_handler_map* that

corresponds to *orig_handler*.

*legend_handler_map* should be a dictionary object (that is

returned by the get_legend_handler_map method).

It first checks if the *orig_handle* itself is a key in the

*legend_handler_map* and return the associated value.

Otherwise, it checks for each of the classes in its

method-resolution-order. If no matching key is found, it

returns ``None``.

"""

try:

return legend_handler_map[orig_handle]

except (TypeError, KeyError): # TypeError if unhashable.

pass

for handle_type in type(orig_handle).mro():

try:

return legend_handler_map[handle_type]

except KeyError:

pass

return None</div>

def _init_legend_box(self, handles, labels, markerfirst=True):

"""

Initialize the legend_box. The legend_box is an instance of

the OffsetBox, which is packed with legend handles and

texts. Once packed, their location is calculated during the

drawing time.

"""

fontsize = self._fontsize

# legend_box is a HPacker, horizontally packed with

# columns. Each column is a VPacker, vertically packed with

# legend items. Each legend item is HPacker packed with

# legend handleBox and labelBox. handleBox is an instance of

# offsetbox.DrawingArea which contains legend handle. labelBox

# is an instance of offsetbox.TextArea which contains legend

# text.

text_list = [] # the list of text instances

handle_list = [] # the list of text instances

handles_and_labels = []

label_prop = dict(verticalalignment='baseline',

horizontalalignment='left',

fontproperties=self.prop,

)

# The approximate height and descent of text. These values are

# only used for plotting the legend handle.

descent = 0.35 * fontsize * (self.handleheight - 0.7)

# 0.35 and 0.7 are just heuristic numbers and may need to be improved.

height = fontsize * self.handleheight - descent

# each handle needs to be drawn inside a box of (x, y, w, h) =

# (0, -descent, width, height). And their coordinates should

# be given in the display coordinates.

# The transformation of each handle will be automatically set

# to self.get_transform(). If the artist does not use its

# default transform (e.g., Collections), you need to

# manually set their transform to the self.get_transform().

legend_handler_map = self.get_legend_handler_map()

for orig_handle, lab in zip(handles, labels):

handler = self.get_legend_handler(legend_handler_map, orig_handle)

if handler is None:

cbook._warn_external(

"Legend does not support {!r} instances.\nA proxy artist "

"may be used instead.\nSee: "

"https://matplotlib.org/users/legend_guide.html"

"#creating-artists-specifically-for-adding-to-the-legend-"

"aka-proxy-artists".format(orig_handle))

# We don't have a handle for this artist, so we just defer

# to None.

handle_list.append(None)

else:

textbox = TextArea(lab, textprops=label_prop,

multilinebaseline=True,

minimumdescent=True)

handlebox = DrawingArea(width=self.handlelength * fontsize,

height=height,

xdescent=0., ydescent=descent)

text_list.append(textbox._text)

# Create the artist for the legend which represents the

# original artist/handle.

handle_list.append(handler.legend_artist(self, orig_handle,

fontsize, handlebox))

handles_and_labels.append((handlebox, textbox))

if handles_and_labels:

# We calculate number of rows in each column. The first

# (num_largecol) columns will have (nrows+1) rows, and remaining

# (num_smallcol) columns will have (nrows) rows.

ncol = min(self._ncol, len(handles_and_labels))

nrows, num_largecol = divmod(len(handles_and_labels), ncol)

num_smallcol = ncol - num_largecol

# starting index of each column and number of rows in it.

rows_per_col = [nrows + 1] * num_largecol + [nrows] * num_smallcol

start_idxs = np.concatenate([[0], np.cumsum(rows_per_col)[:-1]])

cols = zip(start_idxs, rows_per_col)

else:

cols = []

columnbox = []

for i0, di in cols:

# pack handleBox and labelBox into itemBox

itemBoxes = [HPacker(pad=0,

sep=self.handletextpad * fontsize,

children=[h, t] if markerfirst else [t, h],

align="baseline")

for h, t in handles_and_labels[i0:i0 + di]]

# minimumdescent=False for the text of the last row of the column

if markerfirst:

itemBoxes[-1].get_children()[1].set_minimumdescent(False)

else:

itemBoxes[-1].get_children()[0].set_minimumdescent(False)

# pack columnBox

alignment = "baseline" if markerfirst else "right"

columnbox.append(VPacker(pad=0,

sep=self.labelspacing * fontsize,

align=alignment,

children=itemBoxes))

mode = "expand" if self._mode == "expand" else "fixed"

sep = self.columnspacing * fontsize

self._legend_handle_box = HPacker(pad=0,

sep=sep, align="baseline",

mode=mode,

children=columnbox)

self._legend_title_box = TextArea("")

self._legend_box = VPacker(pad=self.borderpad * fontsize,

align="center",

children=[self._legend_title_box,

self._legend_handle_box])

self._legend_box.set_figure(self.figure)

self.texts = text_list

self.legendHandles = handle_list

def _auto_legend_data(self):

"""

Return display coordinates for hit testing for "best" positioning.

Returns

-------

bboxes

List of bounding boxes of all patches.

lines

List of `.Path` corresponding to each line.

offsets

List of (x, y) offsets of all collection.

"""

assert self.isaxes # always holds, as this is only called internally

ax = self.parent

lines = [line.get_transform().transform_path(line.get_path())

for line in ax.lines]

bboxes = [patch.get_bbox().transformed(patch.get_data_transform())

if isinstance(patch, Rectangle) else

patch.get_path().get_extents(patch.get_transform())

for patch in ax.patches]

offsets = []

for handle in ax.collections:

_, transOffset, hoffsets, _ = handle._prepare_points()

for offset in transOffset.transform(hoffsets):

offsets.append(offset)

return bboxes, lines, offsets

<div class="viewcode-block" id="Legend.get_children"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_children">[docs]</a> def get_children(self):

# docstring inherited

return [self._legend_box, self.get_frame()]</div>

<div class="viewcode-block" id="Legend.get_frame"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_frame">[docs]</a> def get_frame(self):

"""Return the `~.patches.Rectangle` used to frame the legend."""

return self.legendPatch</div>

<div class="viewcode-block" id="Legend.get_lines"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_lines">[docs]</a> def get_lines(self):

r"""Return the list of `~.lines.Line2D`\s in the legend."""

return [h for h in self.legendHandles if isinstance(h, Line2D)]</div>

<div class="viewcode-block" id="Legend.get_patches"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_patches">[docs]</a> def get_patches(self):

r"""Return the list of `~.patches.Patch`\s in the legend."""

return silent_list('Patch',

[h for h in self.legendHandles

if isinstance(h, Patch)])</div>

<div class="viewcode-block" id="Legend.get_texts"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.get_texts">[docs]</a> def get_texts(self):

r"""Return the list of `~.text.Text`\s in the legend."""

return silent_list('Text', self.texts)</div>

<div class="viewcode-block" id="Legend.set_title"><a class="viewcode-back" href="../../api/legend_api.html#matplotlib.legend.Legend.set_title">[docs]</a> def set_title(self, title, prop=None):

"""

Set the legend title. Fontproperties can be optionally set

with *prop* parameter.

"""

self._legend_title_box._text.set_text(title)

if title:

self._legend_title_box._text.set_visible(True)

self._legend_title_box.set_visible(True)

else:

self._legend_title_box._text.set_visible(False)

if prop is not None:

self._legend_title_box._text.set_fontproperties(prop)

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

legend.html

Latest commit

History

legend.html

File metadata and controls